constructor

vfs.VirtualFileSystem.constructor

Not implemented in Bun

constructor VirtualFileSystem(

provider?: VirtualProvider,

options?: VirtualFileSystemOptions

): VirtualFileSystem;

@param provider

The provider to use. Default: new MemoryProvider().

constructor VirtualFileSystem(

options: VirtualFileSystemOptions

): VirtualFileSystem;

Referenced types

class VirtualProvider

The base class for all VFS providers. Subclasses implement the essential primitives (such as open, stat, readdir, mkdir, rmdir, unlink, rename, etc.) and inherit default implementations of the derived methods (such as readFile, writeFile, exists, copyFile, access, etc.).

interface VirtualFileSystemOptions

emitExperimentalWarning?: boolean
Whether to emit the experimental warning. Default: true.

class VirtualFileSystem

A VirtualFileSystem wraps a VirtualProvider and exposes a node:fs-like API. Each instance maintains its own file tree.

access: typeof access
accessSync: (path: PathLike, mode?: number) => void
appendFileSync: (path: PathOrFileDescriptor, data: string | Uint8Array<ArrayBufferLike>, options?: WriteFileOptions) => void
chmodSync: (path: PathLike, mode: Mode) => void
chownSync: (path: PathLike, uid: number, gid: number) => void
close: typeof close
closeSync: (fd: number) => void
copyFileSync: (src: PathLike, dest: PathLike, mode?: number) => void
createReadStream: (path: PathLike, options?: BufferEncoding | ReadStreamOptions) => ReadStream
createWriteStream: (path: PathLike, options?: BufferEncoding | WriteStreamOptions) => WriteStream
existsSync: {}
fstat: typeof fstat
fstatSync: {(fd: number, options?: StatOptions & { bigint: false }) => Stats; (fd: number, options: StatOptions & { bigint: true }) => BigIntStats; (fd: number, options?: StatOptions) => Stats | BigIntStats}
ftruncate: typeof ftruncate
ftruncateSync: (fd: number, len?: number) => void
link: typeof link
linkSync: (existingPath: PathLike, newPath: PathLike) => void
lstat: typeof lstat
lstatSync: {(path: PathLike) => Stats; (path: PathLike, options?: StatOptions & { bigint: false; throwIfNoEntry: true }) => Stats; (path: PathLike, options: StatOptions & { bigint: true; throwIfNoEntry: true }) => BigIntStats; (path: PathLike, options: StatOptions & { bigint: false; throwIfNoEntry: false }) => undefined | Stats; (path: PathLike, options: StatOptions & { bigint: true; throwIfNoEntry: false }) => undefined | BigIntStats; (path: PathLike, options: StatOptions & { throwIfNoEntry: true }) => Stats | BigIntStats; (path: PathLike, options?: StatOptions) => undefined | Stats | BigIntStats}
lutimesSync: (path: PathLike, atime: TimeLike, mtime: TimeLike) => void
mkdirSync: {(path: PathLike, options: MakeDirectoryOptions & { recursive: true }) => undefined | string; (path: PathLike, options?: null | Mode | MakeDirectoryOptions & { recursive: false }) => void; (path: PathLike, options?: null | Mode | MakeDirectoryOptions) => undefined | string}
mkdtemp: typeof mkdtemp
mkdtempSync: {(prefix: string, options?: EncodingOption) => string; (prefix: string, options: BufferEncodingOption) => NonSharedBuffer; (prefix: string, options?: EncodingOption) => string | NonSharedBuffer}
open: typeof open
openAsBlob: (path: PathLike, options?: OpenAsBlobOptions) => Promise<Blob>
opendir: typeof opendir
opendirSync: (path: PathLike, options?: OpenDirOptions) => Dir
openSync: (path: PathLike, flags?: OpenMode, mode?: null | Mode) => number
readonly promises: Pick<__module, 'open' | 'rename' | 'watch' | 'readFile' | 'writeFile' | 'stat' | 'lstat' | 'readdir' | 'realpath' | 'readlink' | 'access' | 'rm' | 'truncate' | 'link' | 'mkdtemp' | 'appendFile' | 'mkdir' | 'rmdir' | 'unlink' | 'copyFile' | 'symlink' | 'chmod' | 'chown' | 'lchown' | 'utimes' | 'lutimes' | 'lchmod'>
readonly provider: VirtualProvider
The provider backing this VFS instance.
read: typeof read
readdir: typeof readdir
readdirSync: {(path: PathLike, options?: null | BufferEncoding | { encoding: unknown; recursive: boolean; withFileTypes: false }) => string[]; (path: PathLike, options: 'buffer' | { encoding: 'buffer'; recursive: boolean; withFileTypes: false }) => NonSharedBuffer[]; (path: PathLike, options?: null | BufferEncoding | ObjectEncodingOptions & { recursive: boolean; withFileTypes: false }) => string[] | NonSharedBuffer[]; (path: PathLike, options: ObjectEncodingOptions & { recursive: boolean; withFileTypes: true }) => Dirent<string>[]; (path: PathLike, options: { encoding: 'buffer'; recursive: boolean; withFileTypes: true }) => Dirent<NonSharedBuffer>[]}
readFile: typeof readFile
readFileSync: {(path: PathOrFileDescriptor, options: ReadFileSyncOptionsWithBuffer<T>) => BufferView<T>; (path: PathOrFileDescriptor, options?: null | ReadFileSyncOptionsWithBufferEncoding) => NonSharedBuffer; (path: PathOrFileDescriptor, options: BufferEncoding | ReadFileSyncOptionsWithStringEncoding) => string; (path: PathOrFileDescriptor, options: ReadFileSyncOptions) => string | NonSharedBuffer}
readlink: typeof readlink
readlinkSync: {(path: PathLike, options?: EncodingOption) => string; (path: PathLike, options: BufferEncodingOption) => NonSharedBuffer; (path: PathLike, options?: EncodingOption) => string | NonSharedBuffer}
readonly readonly: boolean
true when the underlying provider is read-only.
readSync: {(fd: number, buffer: ArrayBufferView, offset: number, length: number, position?: null | ReadPosition) => number; (fd: number, buffer: ArrayBufferView, opts?: ReadOptions) => number}
realpath: typeof realpath
realpathSync: typeof realpathSync
renameSync: (oldPath: PathLike, newPath: PathLike) => void
rm: typeof rm
rmdirSync: (path: PathLike) => void
rmSync: (path: PathLike, options?: RmOptions) => void
stat: typeof stat
statSync: {(path: PathLike) => Stats; (path: PathLike, options?: StatOptions & { bigint: false; throwIfNoEntry: true }) => Stats; (path: PathLike, options: StatOptions & { bigint: true; throwIfNoEntry: true }) => BigIntStats; (path: PathLike, options: StatOptions & { bigint: false; throwIfNoEntry: false }) => undefined | Stats; (path: PathLike, options: StatOptions & { bigint: true; throwIfNoEntry: false }) => undefined | BigIntStats; (path: PathLike, options: StatOptions & { throwIfNoEntry: true }) => Stats | BigIntStats; (path: PathLike, options?: StatOptions) => undefined | Stats | BigIntStats}
symlinkSync: (target: PathLike, path: PathLike, type?: null | Type) => void
truncate: typeof truncate
truncateSync: {}
unlinkSync: (path: PathLike) => void
unwatchFile: {(filename: PathLike, listener?: StatsListener) => void; (filename: PathLike, listener?: BigIntStatsListener) => void}
utimesSync: (path: PathLike, atime: TimeLike, mtime: TimeLike) => void
watch: {(filename: PathLike, options?: null | BufferEncoding | WatchOptionsWithStringEncoding, listener?: WatchListener<string>) => FSWatcher; (filename: PathLike, options: 'buffer' | WatchOptionsWithBufferEncoding, listener: WatchListener<NonSharedBuffer>) => FSWatcher; (filename: PathLike, options: null | BufferEncoding | 'buffer' | WatchOptions, listener: WatchListener<string | NonSharedBuffer>) => FSWatcher; (filename: PathLike, listener: WatchListener<string>) => FSWatcher}
watchFile: {(filename: PathLike, options: undefined | WatchFileOptions & { bigint: false }, listener: StatsListener) => StatWatcher; (filename: PathLike, options: undefined | WatchFileOptions & { bigint: true }, listener: BigIntStatsListener) => StatWatcher; (filename: PathLike, listener: StatsListener) => StatWatcher}
write: typeof write
writeFile: typeof writeFile
writeFileSync: (file: PathOrFileDescriptor, data: string | ArrayBufferView<ArrayBufferLike>, options?: WriteFileOptions) => void
writeSync: {(fd: number, buffer: ArrayBufferView, offset?: null | number, length?: null | number, position?: null | number) => number; (fd: number, string: string, position?: null | number, encoding?: null | BufferEncoding) => number}