BoundContext
Defined in: src/internal/contexts.ts:74
Allows you to restrict operations to a specific root path and set of credentials.
Extends
Section titled “Extends”Properties
Section titled “Properties”[kIsContext]
Section titled “[kIsContext]”
readonly[kIsContext]:boolean
Defined in: src/internal/contexts.ts:26
Brand
Inherited from
Section titled “Inherited from”children
Section titled “children”
readonlychildren:FSContext[]
Defined in: src/internal/contexts.ts:51
The child contexts
Inherited from
Section titled “Inherited from”credentials
Section titled “credentials”
readonlycredentials:Credentials
Defined in: src/internal/contexts.ts:42
The credentials of the context, used for access checks
Inherited from
Section titled “Inherited from”descriptors
Section titled “descriptors”
readonlydescriptors:Map<number,Handle>
Defined in: src/internal/contexts.ts:45
A map of open file descriptors to their handles
Inherited from
Section titled “Inherited from”fs:
__module&object&object
Defined in: src/internal/contexts.ts:75
Type Declaration
Section titled “Type Declaration”access
Section titled “access”access: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, number, Callback]
Returns
Section titled “Returns”void
accessSync
Section titled “accessSync”accessSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, number]
Returns
Section titled “Returns”void
appendFile
Section titled “appendFile”appendFile: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, FileContents, BufferEncoding, Callback]
Returns
Section titled “Returns”void
appendFileSync
Section titled “appendFileSync”appendFileSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathOrFileDescriptor, FileContents, WriteFileOptions]
Returns
Section titled “Returns”void
BigIntStatsFs
Section titled “BigIntStatsFs”BigIntStatsFs: typeof
BigIntStatsFs
chmod: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, string | number, Callback]
Returns
Section titled “Returns”void
chmodSync
Section titled “chmodSync”chmodSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, Mode]
Returns
Section titled “Returns”void
chown: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, number, number, Callback]
Returns
Section titled “Returns”void
chownSync
Section titled “chownSync”chownSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, number, number]
Returns
Section titled “Returns”void
close: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, Callback]
Returns
Section titled “Returns”void
closeSync
Section titled “closeSync”closeSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number]
Returns
Section titled “Returns”void
constants
Section titled “constants”constants:
constants
copyFile
Section titled “copyFile”copyFile: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, PathLike, number, Callback]
Returns
Section titled “Returns”void
copyFileSync
Section titled “copyFileSync”copyFileSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, PathLike, number]
Returns
Section titled “Returns”void
cp: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, PathLike, CopyOptions, Callback]
Returns
Section titled “Returns”void
cpSync
Section titled “cpSync”cpSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, PathLike, CopySyncOptions]
Returns
Section titled “Returns”void
createReadStream
Section titled “createReadStream”createReadStream: (
this, …args) =>ReadStream
Parameters
Section titled “Parameters”…[PathLike, BufferEncoding | ReadStreamOptions]
Returns
Section titled “Returns”createWriteStream
Section titled “createWriteStream”createWriteStream: (
this, …args) =>WriteStream
Parameters
Section titled “Parameters”…[PathLike, BufferEncoding | WriteStreamOptions]
Returns
Section titled “Returns”Dir: typeof
Dir
Dirent
Section titled “Dirent”Dirent: typeof
Dirent
exists
Section titled “exists”exists: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, (exists) => unknown]
Returns
Section titled “Returns”void
existsSync
Section titled “existsSync”existsSync: (
this, …args) =>boolean
Parameters
Section titled “Parameters”…[PathLike]
Returns
Section titled “Returns”boolean
fchmod
Section titled “fchmod”fchmod: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, string | number, Callback]
Returns
Section titled “Returns”void
fchmodSync
Section titled “fchmodSync”fchmodSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, string | number]
Returns
Section titled “Returns”void
fchown
Section titled “fchown”fchown: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, number, number, Callback]
Returns
Section titled “Returns”void
fchownSync
Section titled “fchownSync”fchownSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, number, number]
Returns
Section titled “Returns”void
fdatasync
Section titled “fdatasync”fdatasync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, Callback]
Returns
Section titled “Returns”void
fdatasyncSync
Section titled “fdatasyncSync”fdatasyncSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number]
Returns
Section titled “Returns”void
fstat: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, StatOptions & object, Callback<[BigIntStats]>]
Returns
Section titled “Returns”void
fstatSync
Section titled “fstatSync”fstatSync: (
this, …args) =>BigIntStats
Parameters
Section titled “Parameters”…[number, object]
Returns
Section titled “Returns”BigIntStats
fsync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, Callback]
Returns
Section titled “Returns”void
fsyncSync
Section titled “fsyncSync”fsyncSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number]
Returns
Section titled “Returns”void
ftruncate
Section titled “ftruncate”ftruncate: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, number, Callback]
Returns
Section titled “Returns”void
ftruncateSync
Section titled “ftruncateSync”ftruncateSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, number | null]
Returns
Section titled “Returns”void
futimes
Section titled “futimes”futimes: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, number | Date, number | Date, Callback]
Returns
Section titled “Returns”void
futimesSync
Section titled “futimesSync”futimesSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, TimeLike, TimeLike]
Returns
Section titled “Returns”void
glob: (
this, …args) =>void
Parameters
Section titled “Parameters”…[string | readonly string[], GlobOptions<string | Dirent<string>>, GlobCallback<[string[] | Dirent<string>[]]>]
Returns
Section titled “Returns”void
globSync
Section titled “globSync”globSync: (
this, …args) =>string[] |Dirent<string>[]
Parameters
Section titled “Parameters”…[string | readonly string[], GlobOptions<string | Dirent<string>>]
Returns
Section titled “Returns”string[] | Dirent<string>[]
lchmod
Section titled “lchmod”lchmod: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, string | number, Callback]
Returns
Section titled “Returns”void
lchmodSync
Section titled “lchmodSync”lchmodSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, string | number]
Returns
Section titled “Returns”void
lchown
Section titled “lchown”lchown: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, number, number, Callback]
Returns
Section titled “Returns”void
lchownSync
Section titled “lchownSync”lchownSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, number, number]
Returns
Section titled “Returns”void
link: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, PathLike, Callback]
Returns
Section titled “Returns”void
linkSync
Section titled “linkSync”linkSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, PathLike]
Returns
Section titled “Returns”void
lopenSync
Section titled “lopenSync”lopenSync: (
this, …args) =>number
Parameters
Section titled “Parameters”…[PathLike, string, Mode | null]
Returns
Section titled “Returns”number
lstat: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, StatOptions, Callback<[BigIntStats | Stats]>]
Returns
Section titled “Returns”void
lstatSync
Section titled “lstatSync”lstatSync: (
this, …args) =>BigIntStats|Stats|undefined
Parameters
Section titled “Parameters”…[PathLike, StatOptions]
Returns
Section titled “Returns”BigIntStats | Stats | undefined
lutimes
Section titled “lutimes”lutimes: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, number | Date, number | Date, Callback]
Returns
Section titled “Returns”void
lutimesSync
Section titled “lutimesSync”lutimesSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, TimeLike, TimeLike]
Returns
Section titled “Returns”void
mkdir: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, Mode, Callback]
Returns
Section titled “Returns”void
mkdirSync
Section titled “mkdirSync”mkdirSync: (
this, …args) =>string|undefined
Parameters
Section titled “Parameters”…[PathLike, Mode | MakeDirectoryOptions | null]
Returns
Section titled “Returns”string | undefined
mkdtemp
Section titled “mkdtemp”mkdtemp: (
this, …args) =>void
Parameters
Section titled “Parameters”…[string, BufferEncodingOption, Callback<[Buffer<ArrayBufferLike>]>]
Returns
Section titled “Returns”void
mkdtempDisposableSync
Section titled “mkdtempDisposableSync”mkdtempDisposableSync: (
this, …args) =>object
Parameters
Section titled “Parameters”…[PathLike, BufferEncodingOption | EncodingOption]
Returns
Section titled “Returns”object
path:
string
[dispose]()
Section titled “[dispose]()”[dispose]():
void
Returns
Section titled “Returns”void
remove()
Section titled “remove()”remove():
void
Returns
Section titled “Returns”void
mkdtempSync
Section titled “mkdtempSync”mkdtempSync: (
this, …args) =>string
Parameters
Section titled “Parameters”…[PathLike, EncodingOption]
Returns
Section titled “Returns”string
open: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, OpenMode, string | number, Callback<[number]>]
Returns
Section titled “Returns”void
openAsBlob
Section titled “openAsBlob”openAsBlob: (
this, …args) =>Promise<Blob>
Parameters
Section titled “Parameters”…[PathLike, OpenAsBlobOptions]
Returns
Section titled “Returns”Promise<Blob>
opendir
Section titled “opendir”opendir: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, OpenDirOptions, Callback<[Dir]>]
Returns
Section titled “Returns”void
opendirSync
Section titled “opendirSync”opendirSync: (
this, …args) =>Dir
Parameters
Section titled “Parameters”…[PathLike, OpenDirOptions]
Returns
Section titled “Returns”openSync
Section titled “openSync”openSync: (
this, …args) =>number
Parameters
Section titled “Parameters”…[PathLike, OpenMode, Mode | null]
Returns
Section titled “Returns”number
promises
Section titled “promises”promises:
promises
read: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, Uint8Array<ArrayBufferLike>, number, number, number, Callback<[number, Uint8Array<ArrayBufferLike>]>]
Returns
Section titled “Returns”void
readdir
Section titled “readdir”readdir: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, object, Callback<[Dirent<string>[]]>]
Returns
Section titled “Returns”void
readdirSync
Section titled “readdirSync”readdirSync: (
this, …args) =>string[] |Dirent<any>[] |Buffer<ArrayBufferLike>[]
Parameters
Section titled “Parameters”…[PathLike, NodeReaddirOptions]
Returns
Section titled “Returns”string[] | Dirent<any>[] | Buffer<ArrayBufferLike>[]
readFile
Section titled “readFile”readFile: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, BufferEncoding | { encoding: BufferEncoding; flag?: string; }, Callback<[string]>]
Returns
Section titled “Returns”void
readFileSync
Section titled “readFileSync”readFileSync: (
this, …args) =>string
Parameters
Section titled “Parameters”…[PathOrFileDescriptor, BufferEncoding | EncodingOption & { flag?: string | undefined; } | null]
Returns
Section titled “Returns”string
readlink
Section titled “readlink”readlink: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, EncodingOption, Callback<[string]>]
Returns
Section titled “Returns”void
readlinkSync
Section titled “readlinkSync”readlinkSync: (
this, …args) =>string|NonSharedBuffer
Parameters
Section titled “Parameters”…[PathLike, "buffer" | { encoding: "buffer"; } | "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptions | null]
Returns
Section titled “Returns”string | NonSharedBuffer
ReadStream
Section titled “ReadStream”ReadStream: typeof
ReadStream
readSync
Section titled “readSync”readSync: (
this, …args) =>number
Parameters
Section titled “Parameters”…[number, ArrayBufferView<ArrayBufferLike>, number, number, ReadPosition | null]
Returns
Section titled “Returns”number
readv: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, ArrayBufferView<ArrayBufferLike>[], number, readvCb]
Returns
Section titled “Returns”void
readvSync
Section titled “readvSync”readvSync: (
this, …args) =>number
Parameters
Section titled “Parameters”…[number, readonly ArrayBufferView<ArrayBufferLike>[], number]
Returns
Section titled “Returns”number
realpath
Section titled “realpath”realpath: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, EncodingOption, Callback<[string]>]
Returns
Section titled “Returns”void
realpathSync
Section titled “realpathSync”realpathSync: (
this, …args) =>string
Parameters
Section titled “Parameters”…[PathLike, EncodingOption]
Returns
Section titled “Returns”string
rename
Section titled “rename”rename: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, PathLike, Callback]
Returns
Section titled “Returns”void
renameSync
Section titled “renameSync”renameSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, PathLike]
Returns
Section titled “Returns”void
rm: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, RmOptions, Callback]
Returns
Section titled “Returns”void
rmdir: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, Callback]
Returns
Section titled “Returns”void
rmdirSync
Section titled “rmdirSync”rmdirSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike]
Returns
Section titled “Returns”void
rmSync
Section titled “rmSync”rmSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, RmOptions]
Returns
Section titled “Returns”void
stat: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, StatOptions, Callback<[BigIntStats | Stats | undefined]>]
Returns
Section titled “Returns”void
statfs
Section titled “statfs”statfs: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, StatFsOptions & object, Callback<[BigIntStatsFs]>]
Returns
Section titled “Returns”void
statfsSync
Section titled “statfsSync”statfsSync: (
this, …args) =>StatsFs|BigIntStatsFs
Parameters
Section titled “Parameters”…[PathLike, StatFsOptions]
Returns
Section titled “Returns”StatsFs | BigIntStatsFs
Stats: typeof
Stats
StatsFs
Section titled “StatsFs”StatsFs: typeof
StatsFs
statSync
Section titled “statSync”statSync: (
this, …args) =>BigIntStats|Stats|undefined
Parameters
Section titled “Parameters”…[PathLike, StatOptions]
Returns
Section titled “Returns”BigIntStats | Stats | undefined
symlink
Section titled “symlink”symlink: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, PathLike, Type, Callback]
Returns
Section titled “Returns”void
symlinkSync
Section titled “symlinkSync”symlinkSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, PathLike, Type | null]
Returns
Section titled “Returns”void
truncate
Section titled “truncate”truncate: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, number, Callback]
Returns
Section titled “Returns”void
truncateSync
Section titled “truncateSync”truncateSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, number | null]
Returns
Section titled “Returns”void
unlink
Section titled “unlink”unlink: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, Callback]
Returns
Section titled “Returns”void
unlinkSync
Section titled “unlinkSync”unlinkSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike]
Returns
Section titled “Returns”void
unwatchFile
Section titled “unwatchFile”unwatchFile: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, (curr, prev) => void]
Returns
Section titled “Returns”void
Utf8Stream
Section titled “Utf8Stream”Utf8Stream: typeof
Utf8Stream
utimes
Section titled “utimes”utimes: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, number | Date, number | Date, Callback]
Returns
Section titled “Returns”void
utimesSync
Section titled “utimesSync”utimesSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, TimeLike, TimeLike]
Returns
Section titled “Returns”void
watch: (
this, …args) =>FSWatcher<string|Buffer<ArrayBufferLike>>
Parameters
Section titled “Parameters”…[PathLike, object, (event, filename) => any]
Returns
Section titled “Returns”FSWatcher<string | Buffer<ArrayBufferLike>>
watchFile
Section titled “watchFile”watchFile: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, object, (curr, prev) => void]
Returns
Section titled “Returns”void
write: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, FileContents, number | null, BufferEncoding, Callback<[number, string]>]
Returns
Section titled “Returns”void
writeFile
Section titled “writeFile”writeFile: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathLike, FileContents, WriteFileOptions, Callback]
Returns
Section titled “Returns”void
writeFileSync
Section titled “writeFileSync”writeFileSync: (
this, …args) =>void
Parameters
Section titled “Parameters”…[PathOrFileDescriptor, FileContents, BufferEncoding]
Returns
Section titled “Returns”void
WriteStream
Section titled “WriteStream”WriteStream: typeof
WriteStream
writeSync
Section titled “writeSync”writeSync: (
this, …args) =>number
Parameters
Section titled “Parameters”…[number, string, number | null, BufferEncoding | null]
Returns
Section titled “Returns”number
writev
Section titled “writev”writev: (
this, …args) =>void
Parameters
Section titled “Parameters”…[number, Uint8Array<ArrayBufferLike>[], number, writevCb]
Returns
Section titled “Returns”void
writevSync
Section titled “writevSync”writevSync: (
this, …args) =>number
Parameters
Section titled “Parameters”…[number, readonly ArrayBufferView<ArrayBufferLike>[], number]
Returns
Section titled “Returns”number
Type Declaration
Section titled “Type Declaration”promises
Section titled “promises”
readonlyid:number
Defined in: src/internal/contexts.ts:29
The unique ID of the context
Inherited from
Section titled “Inherited from”mounts
Section titled “mounts”
readonlymounts:Map<string,FileSystem>
Defined in: src/internal/contexts.ts:54
The mount table for this context
Inherited from
Section titled “Inherited from”parent
Section titled “parent”parent:
FSContext
Defined in: src/internal/contexts.ts:84
The parent context, if any.
Overrides
Section titled “Overrides”path:
Bound<__module,FSContext>
Defined in: src/internal/contexts.ts:78
Path functions, bound to the context
pwd:
string
Defined in: src/internal/contexts.ts:39
The current working directory of the context
Inherited from
Section titled “Inherited from”root:
string
Defined in: src/internal/contexts.ts:36
The absolute root path of the context
Note the parent’s root is not considered
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”bind()
Section titled “bind()”bind(
init):BoundContext
Defined in: src/internal/contexts.ts:81
Creates a new child context with this context as the parent
Parameters
Section titled “Parameters”Returns
Section titled “Returns”BoundContext