Class MemoryFileProvider

An in-memory FileProvider backed by a Map<string, string>.

Intended for unit tests and non-local environments (e.g. a browser or service-worker bundle) — all file I/O stays in-process with no disk access. It depends only on node:path and minimatch, so it carries no Node-only runtime dependencies (no node:fs, chokidar, etc.). Calling writeFile triggers any active watch callbacks synchronously, making it easy to test reactive code paths.

Example

const provider = new MemoryFileProvider({
  '/virtual/prompt.ts': 'export function myPrompt() { ... }',
});
const content = await provider.readFile('/virtual/prompt.ts');

Implements

FileProvider

Index

Constructors

constructor

Methods

deleteFile glob import readFile watch writeFile

Constructors

constructor

new MemoryFileProvider(files?: Record<string, string>): MemoryFileProvider
Parameters
- files: Record<string, string> = {}
  Initial file contents keyed by absolute path.
Returns MemoryFileProvider
- Defined in src/file-provider-memory.ts:46

Methods

deleteFile

deleteFile(filePath: string): Promise<void>
Deletes the file at filePath. When the path falls inside an active watch scope, the watcher callback is invoked automatically with 'remove'.
Parameters
- filePath: string
Returns Promise<void>
Implementation of FileProvider.deleteFile
- Defined in src/file-provider-memory.ts:62

glob

glob(pattern: string, options?: GlobOptions): AsyncIterableIterator<string>
Returns an async iterator that yields paths matching pattern.
Parameters
- pattern: string
  A glob pattern (e.g. '**/*.prompt.ts').
- options: GlobOptions = {}
  See GlobOptions.
Returns AsyncIterableIterator<string>
Implementation of FileProvider.glob
- Defined in src/file-provider-memory.ts:75

import

import(filePath: string): Promise<any>
Dynamically imports the module at filePath and returns its namespace object. Rejects if the file does not exist.
Parameters
- filePath: string
Returns Promise<any>
Implementation of FileProvider.import
- Defined in src/file-provider-memory.ts:67

readFile

readFile(filePath: string): Promise<string>
Reads the file at filePath and returns its content as a UTF-8 string. Rejects if the file does not exist.
Parameters
- filePath: string
Returns Promise<string>
Implementation of FileProvider.readFile
- Defined in src/file-provider-memory.ts:50

watch

watch(
    patterns: readonly string[],
    options: FileWatchOptions,
    callback: FileWatchCallback,
): () => void
Starts watching for changes to files that match patterns and calls callback on each relevant event.
Parameters
- patterns: readonly string[]
  Glob patterns that select which files to watch.
- options: FileWatchOptions
  See FileWatchOptions.
- callback: FileWatchCallback
  Called for each matching file event.
Returns () => void
A cleanup function; call it to stop watching.
Implementation of FileProvider.watch
- Defined in src/file-provider-memory.ts:90

writeFile

writeFile(filePath: string, content: string): Promise<void>
Writes content to filePath, creating or overwriting the file. When the path falls inside an active watch scope, the watcher callback is invoked automatically.
Parameters
- filePath: string
- content: string
Returns Promise<void>
Implementation of FileProvider.writeFile
- Defined in src/file-provider-memory.ts:56

Class MemoryFileProvider

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MemoryFileProvider

Methods

deleteFile

Parameters

Returns Promise<void>

glob

Parameters

Returns AsyncIterableIterator<string>

import

Parameters

Returns Promise<any>

readFile

Parameters

Returns Promise<string>

watch

Parameters

Returns () => void

writeFile

Parameters

Returns Promise<void>

Settings

On This Page