abstractProxiedFS <P, IP>

Hierarchy

FakeFS
- ProxiedFS

Index

Properties

pathUtils

Methods

accessPromise
accessSync
appendFilePromise
appendFileSync
changeFilePromise
changeFileSync
checksumFilePromise
chmodPromise
chmodSync
chownPromise
chownSync
closePromise
closeSync
copyFilePromise
copyFileSync
copyPromise
copySync
createReadStream
createWriteStream
existsPromise
existsSync
fchmodPromise
fchmodSync
fchownPromise
fchownSync
fstatPromise
fstatSync
ftruncatePromise
ftruncateSync
genTraversePromise
getExtractHint
getRealPath
linkPromise
linkSync
lockPromise
lstatPromise
lstatSync
lutimesPromise
lutimesSync
mkdirPromise
mkdirSync
mkdirpPromise
mkdirpSync
movePromise
moveSync
openPromise
openSync
opendirPromise
opendirSync
preserveTimePromise
preserveTimeSync
readFilePromise
readFileSync
readJsonPromise
readJsonSync
readPromise
readSync
readdirPromise
readdirSync
readlinkPromise
readlinkSync
realpathPromise
realpathSync
removePromise
removeSync
renamePromise
renameSync
resolve
rmPromise
rmSync
rmdirPromise
rmdirSync
statPromise
statSync
symlinkPromise
symlinkSync
truncatePromise
truncateSync
unlinkPromise
unlinkSync
unwatchFile
utimesPromise
utimesSync
watch
watchFile
writeFilePromise
writeFileSync
writeJsonPromise
writeJsonSync
writePromise
writeSync

Properties

publicreadonlypathUtils

pathUtils: PathUtils

Methods

accessPromise

accessPromise(p: P, mode?: number): Promise<void>

Overrides FakeFS.accessPromise
Parameters
- p: P
- optionalmode: number
Returns Promise<void>

accessSync

accessSync(p: P, mode?: number): void

Overrides FakeFS.accessSync
Parameters
- p: P
- optionalmode: number
Returns void

appendFilePromise

appendFilePromise(p: FSPath, content: string | Uint8Array, opts?: WriteFileOptions): Promise<void>

Overrides FakeFS.appendFilePromise
Parameters
- p: FSPath
- content: string | Uint8Array
- optionalopts: WriteFileOptions
Returns Promise<void>

appendFileSync

appendFileSync(p: FSPath, content: string | Uint8Array, opts?: WriteFileOptions): void

Overrides FakeFS.appendFileSync
Parameters
- p: FSPath
- content: string | Uint8Array
- optionalopts: WriteFileOptions
Returns void

changeFilePromise

changeFilePromise(p: P, content: Buffer): Promise<void>
changeFilePromise(p: P, content: string, opts?: Partial<{ automaticNewlines: boolean; mode: number }>): Promise<void>

Inherited from FakeFS.changeFilePromise
Parameters
- p: P
- content: Buffer
Returns Promise<void>

changeFileSync

changeFileSync(p: P, content: Buffer): void
changeFileSync(p: P, content: string, opts?: Partial<{ automaticNewlines: boolean; mode: number }>): void

Inherited from FakeFS.changeFileSync
Parameters
- p: P
- content: Buffer
Returns void

checksumFilePromise

checksumFilePromise(path: P, __namedParameters?: { algorithm?: string }): Promise<string>

Inherited from FakeFS.checksumFilePromise
Parameters
- path: P
- __namedParameters: { algorithm?: string } = {}
Returns Promise<string>

chmodPromise

chmodPromise(p: P, mask: number): Promise<void>

Overrides FakeFS.chmodPromise
Parameters
- p: P
- mask: number
Returns Promise<void>

chmodSync

chmodSync(p: P, mask: number): void

Overrides FakeFS.chmodSync
Parameters
- p: P
- mask: number
Returns void

chownPromise

chownPromise(p: P, uid: number, gid: number): Promise<void>

Overrides FakeFS.chownPromise
Parameters
- p: P
- uid: number
- gid: number
Returns Promise<void>

chownSync

chownSync(p: P, uid: number, gid: number): void

Overrides FakeFS.chownSync
Parameters
- p: P
- uid: number
- gid: number
Returns void

closePromise

closePromise(fd: number): Promise<void>

Overrides FakeFS.closePromise
Parameters
- fd: number
Returns Promise<void>

closeSync

closeSync(fd: number): void

Overrides FakeFS.closeSync
Parameters
- fd: number
Returns void

copyFilePromise

copyFilePromise(sourceP: P, destP: P, flags?: number): Promise<void>

Overrides FakeFS.copyFilePromise
Parameters
- sourceP: P
- destP: P
- flags: number = 0
Returns Promise<void>

copyFileSync

copyFileSync(sourceP: P, destP: P, flags?: number): void

Overrides FakeFS.copyFileSync
Parameters
- sourceP: P
- destP: P
- flags: number = 0
Returns void

copyPromise

copyPromise(destination: P, source: P, options?: { baseFs?: undefined; linkStrategy?: null | LinkStrategy; overwrite?: boolean; stableSort?: boolean; stableTime?: boolean }): Promise<void>
copyPromise<P2>(destination: P, source: P2, options: { baseFs: FakeFS<P2>; linkStrategy?: null | LinkStrategy; overwrite?: boolean; stableSort?: boolean; stableTime?: boolean }): Promise<void>

Inherited from FakeFS.copyPromise
Parameters
- destination: P
- source: P
- optionaloptions: { baseFs?: undefined; linkStrategy?: null | LinkStrategy; overwrite?: boolean; stableSort?: boolean; stableTime?: boolean }
Returns Promise<void>

copySync

copySync(destination: P, source: P, options?: { baseFs?: undefined; overwrite?: boolean }): void
copySync<P2>(destination: P, source: P2, options: { baseFs: FakeFS<P2>; overwrite?: boolean }): void

Inherited from FakeFS.copySync
@deprecated
Prefer using copyPromise instead
Parameters
- destination: P
- source: P
- optionaloptions: { baseFs?: undefined; overwrite?: boolean }
Returns void

createReadStream

createReadStream(p: null | P, opts?: Partial<{ encoding: BufferEncoding; fd: number }>): ReadStream

Overrides FakeFS.createReadStream
Parameters
- p: null | P
- optionalopts: Partial<{ encoding: BufferEncoding; fd: number }>
Returns ReadStream

createWriteStream

createWriteStream(p: null | P, opts?: Partial<{ encoding: BufferEncoding; fd: number; flags: a }>): WriteStream

Overrides FakeFS.createWriteStream
Parameters
- p: null | P
- optionalopts: Partial<{ encoding: BufferEncoding; fd: number; flags: a }>
Returns WriteStream

existsPromise

existsPromise(p: P): Promise<boolean>

Overrides FakeFS.existsPromise
Parameters
- p: P
Returns Promise<boolean>

existsSync

existsSync(p: P): boolean

Overrides FakeFS.existsSync
Parameters
- p: P
Returns boolean

fchmodPromise

fchmodPromise(fd: number, mask: number): Promise<void>

Overrides FakeFS.fchmodPromise
Parameters
- fd: number
- mask: number
Returns Promise<void>

fchmodSync

fchmodSync(fd: number, mask: number): void

Overrides FakeFS.fchmodSync
Parameters
- fd: number
- mask: number
Returns void

fchownPromise

fchownPromise(fd: number, uid: number, gid: number): Promise<void>

Overrides FakeFS.fchownPromise
Parameters
- fd: number
- uid: number
- gid: number
Returns Promise<void>

fchownSync

fchownSync(fd: number, uid: number, gid: number): void

Overrides FakeFS.fchownSync
Parameters
- fd: number
- uid: number
- gid: number
Returns void

fstatPromise

fstatPromise(fd: number): Promise<Stats>
fstatPromise(fd: number, opts: { bigint: true }): Promise<BigIntStats>
fstatPromise(fd: number, opts?: { bigint: boolean }): Promise<Stats | BigIntStats>

Overrides FakeFS.fstatPromise
Parameters
- fd: number
Returns Promise<Stats>

fstatSync

fstatSync(fd: number): Stats
fstatSync(fd: number, opts: { bigint: true }): BigIntStats
fstatSync(fd: number, opts?: { bigint: boolean }): Stats | BigIntStats

Overrides FakeFS.fstatSync
Parameters
- fd: number
Returns Stats

ftruncatePromise

ftruncatePromise(fd: number, len?: number): Promise<void>

Overrides FakeFS.ftruncatePromise
Parameters
- fd: number
- optionallen: number
Returns Promise<void>

ftruncateSync

ftruncateSync(fd: number, len?: number): void

Overrides FakeFS.ftruncateSync
Parameters
- fd: number
- optionallen: number
Returns void

genTraversePromise

genTraversePromise(init: P, __namedParameters?: { stableSort?: boolean }): AsyncGenerator<P, void, unknown>

Inherited from FakeFS.genTraversePromise
Parameters
- init: P
- __namedParameters: { stableSort?: boolean } = {}
Returns AsyncGenerator<P, void, unknown>

getExtractHint

getExtractHint(hints: ExtractHintOptions): boolean

Overrides FakeFS.getExtractHint
@deprecated: Moved to jsInstallUtils
Parameters
- hints: ExtractHintOptions
Returns boolean

getRealPath

getRealPath(): P

Overrides FakeFS.getRealPath
Returns P

linkPromise

linkPromise(existingP: P, newP: P): Promise<void>

Overrides FakeFS.linkPromise
Parameters
- existingP: P
- newP: P
Returns Promise<void>

linkSync

linkSync(existingP: P, newP: P): void

Overrides FakeFS.linkSync
Parameters
- existingP: P
- newP: P
Returns void

lockPromise

lockPromise<T>(affectedPath: P, callback: () => Promise<T>): Promise<T>

Inherited from FakeFS.lockPromise
Type parameters
- T
Parameters
- affectedPath: P
- callback: () => Promise<T>
Returns Promise<T>

lstatPromise

lstatPromise(p: P): Promise<Stats>
lstatPromise(p: P, opts: undefined | (StatOptions & { bigint?: false })): Promise<Stats>
lstatPromise(p: P, opts: StatOptions & { bigint: true }): Promise<BigIntStats>

Overrides FakeFS.lstatPromise
Parameters
- p: P
Returns Promise<Stats>

lstatSync

lstatSync(p: P): Stats
lstatSync(p: P, opts?: StatSyncOptions & { bigint?: false; throwIfNoEntry: false }): undefined | Stats
lstatSync(p: P, opts: StatSyncOptions & { bigint: true; throwIfNoEntry: false }): undefined | BigIntStats
lstatSync(p: P, opts?: StatSyncOptions & { bigint?: false }): Stats
lstatSync(p: P, opts: StatSyncOptions & { bigint: true }): BigIntStats
lstatSync(p: P, opts: StatSyncOptions & { bigint: boolean; throwIfNoEntry?: false }): Stats | BigIntStats

Overrides FakeFS.lstatSync
Parameters
- p: P
Returns Stats

lutimesPromise

lutimesPromise(p: P, atime: string | number | Date, mtime: string | number | Date): Promise<void>

Overrides FakeFS.lutimesPromise
Parameters
- p: P
- atime: string | number | Date
- mtime: string | number | Date
Returns Promise<void>

lutimesSync

lutimesSync(p: P, atime: string | number | Date, mtime: string | number | Date): void

Overrides FakeFS.lutimesSync
Parameters
- p: P
- atime: string | number | Date
- mtime: string | number | Date
Returns void

mkdirPromise

mkdirPromise(p: P, opts?: Partial<{ mode: number; recursive: boolean }>): Promise<undefined | string>

Overrides FakeFS.mkdirPromise
Parameters
- p: P
- optionalopts: Partial<{ mode: number; recursive: boolean }>
Returns Promise<undefined | string>

mkdirSync

mkdirSync(p: P, opts?: Partial<{ mode: number; recursive: boolean }>): undefined | string

Overrides FakeFS.mkdirSync
Parameters
- p: P
- optionalopts: Partial<{ mode: number; recursive: boolean }>
Returns undefined | string

mkdirpPromise

mkdirpPromise(p: P, __namedParameters?: { chmod?: number; utimes?: [string | number | Date, string | number | Date] }): Promise<undefined | string>

Inherited from FakeFS.mkdirpPromise
Parameters
- p: P
- __namedParameters: { chmod?: number; utimes?: [string | number | Date, string | number | Date] } = {}
Returns Promise<undefined | string>

mkdirpSync

mkdirpSync(p: P, __namedParameters?: { chmod?: number; utimes?: [string | number | Date, string | number | Date] }): undefined | string

Inherited from FakeFS.mkdirpSync
Parameters
- p: P
- __namedParameters: { chmod?: number; utimes?: [string | number | Date, string | number | Date] } = {}
Returns undefined | string

movePromise

movePromise(fromP: P, toP: P): Promise<void>

Inherited from FakeFS.movePromise
Parameters
- fromP: P
- toP: P
Returns Promise<void>

moveSync

moveSync(fromP: P, toP: P): void

Inherited from FakeFS.moveSync
Parameters
- fromP: P
- toP: P
Returns void

openPromise

openPromise(p: P, flags: string, mode?: number): Promise<number>

Overrides FakeFS.openPromise
Parameters
- p: P
- flags: string
- optionalmode: number
Returns Promise<number>

openSync

openSync(p: P, flags: string, mode?: number): number

Overrides FakeFS.openSync
Parameters
- p: P
- flags: string
- optionalmode: number
Returns number

opendirPromise

opendirPromise(p: P, opts?: Partial<{ bufferSize: number; recursive: boolean }>): Promise<Dir>

Overrides FakeFS.opendirPromise
Parameters
- p: P
- optionalopts: Partial<{ bufferSize: number; recursive: boolean }>
Returns Promise<Dir>

opendirSync

opendirSync(p: P, opts?: Partial<{ bufferSize: number; recursive: boolean }>): Dir

Overrides FakeFS.opendirSync
Parameters
- p: P
- optionalopts: Partial<{ bufferSize: number; recursive: boolean }>
Returns Dir

preserveTimePromise

preserveTimePromise(p: P, cb: () => Promise<void | P>): Promise<void>

Inherited from FakeFS.preserveTimePromise
Parameters
- p: P
- cb: () => Promise<void | P>
Returns Promise<void>

preserveTimeSync

preserveTimeSync(p: P, cb: () => void | P): Promise<void>

Inherited from FakeFS.preserveTimeSync
Parameters
- p: P
- cb: () => void | P
Returns Promise<void>

readFilePromise

readFilePromise(p: FSPath, encoding?: null): Promise<Buffer>
readFilePromise(p: FSPath, encoding: BufferEncoding): Promise<string>
readFilePromise(p: FSPath, encoding?: null | BufferEncoding): Promise<string | Buffer>

Overrides FakeFS.readFilePromise
Parameters
- p: FSPath
- optionalencoding: null
Returns Promise<Buffer>

readFileSync

readFileSync(p: FSPath, encoding?: null): Buffer
readFileSync(p: FSPath, encoding: BufferEncoding): string
readFileSync(p: FSPath, encoding?: null | BufferEncoding): string | Buffer

Overrides FakeFS.readFileSync
Parameters
- p: FSPath
- optionalencoding: null
Returns Buffer

readJsonPromise

readJsonPromise(p: P): Promise<any>

Inherited from FakeFS.readJsonPromise
Parameters
- p: P
Returns Promise<any>

readJsonSync

readJsonSync(p: P): any

Inherited from FakeFS.readJsonSync
Parameters
- p: P
Returns any

readPromise

readPromise(fd: number, buffer: Buffer, offset?: number, length?: number, position?: null | number): Promise<number>

Overrides FakeFS.readPromise
Parameters
- fd: number
- buffer: Buffer
- optionaloffset: number
- optionallength: number
- optionalposition: null | number
Returns Promise<number>

readSync

readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number

Overrides FakeFS.readSync
Parameters
- fd: number
- buffer: Buffer
- offset: number
- length: number
- position: number
Returns number

readdirPromise

readdirPromise(p: P, opts?: null): Promise<Filename[]>
readdirPromise(p: P, opts: { recursive?: false; withFileTypes: true }): Promise<DirentNoPath[]>
readdirPromise(p: P, opts: { recursive?: false; withFileTypes?: false }): Promise<Filename[]>
readdirPromise(p: P, opts: { recursive?: false; withFileTypes: boolean }): Promise<(Filename | DirentNoPath)[]>
readdirPromise(p: P, opts: { recursive: true; withFileTypes: true }): Promise<Dirent[]>
readdirPromise(p: P, opts: { recursive: true; withFileTypes?: false }): Promise<P[]>
readdirPromise(p: P, opts: { recursive: true; withFileTypes: boolean }): Promise<(P | Dirent)[]>
readdirPromise(p: P, opts: { recursive: boolean; withFileTypes: true }): Promise<(DirentNoPath | Dirent)[]>
readdirPromise(p: P, opts: { recursive: boolean; withFileTypes?: false }): Promise<P[]>
readdirPromise(p: P, opts: { recursive: boolean; withFileTypes: boolean }): Promise<(P | DirentNoPath | Dirent)[]>

Overrides FakeFS.readdirPromise
Parameters
- p: P
- optionalopts: null
Returns Promise<Filename[]>

readdirSync

readdirSync(p: P, opts?: null): Filename[]
readdirSync(p: P, opts: { recursive?: false; withFileTypes: true }): DirentNoPath[]
readdirSync(p: P, opts: { recursive?: false; withFileTypes?: false }): Filename[]
readdirSync(p: P, opts: { recursive?: false; withFileTypes: boolean }): (Filename | DirentNoPath)[]
readdirSync(p: P, opts: { recursive: true; withFileTypes: true }): Dirent[]
readdirSync(p: P, opts: { recursive: true; withFileTypes?: false }): P[]
readdirSync(p: P, opts: { recursive: true; withFileTypes: boolean }): (P | Dirent)[]
readdirSync(p: P, opts: { recursive: boolean; withFileTypes: true }): (DirentNoPath | Dirent)[]
readdirSync(p: P, opts: { recursive: boolean; withFileTypes?: false }): P[]
readdirSync(p: P, opts: { recursive: boolean; withFileTypes: boolean }): (P | DirentNoPath | Dirent)[]

Overrides FakeFS.readdirSync
Parameters
- p: P
- optionalopts: null
Returns Filename[]

readlinkPromise

readlinkPromise(p: P): Promise

Overrides FakeFS.readlinkPromise
Parameters
- p: P
Returns Promise

readlinkSync

readlinkSync(p: P): P

Overrides FakeFS.readlinkSync
Parameters
- p: P
Returns P

realpathPromise

realpathPromise(p: P): Promise

Overrides FakeFS.realpathPromise
Parameters
- p: P
Returns Promise

realpathSync

realpathSync(p: P): P

Overrides FakeFS.realpathSync
Parameters
- p: P
Returns P

removePromise

removePromise(p: P, __namedParameters?: { maxRetries?: number; recursive?: boolean }): Promise<void>

Inherited from FakeFS.removePromise
Parameters
- p: P
- __namedParameters: { maxRetries?: number; recursive?: boolean } = {}
Returns Promise<void>

removeSync

removeSync(p: P, __namedParameters?: { recursive?: boolean }): void

Inherited from FakeFS.removeSync
Parameters
- p: P
- __namedParameters: { recursive?: boolean } = {}
Returns void

renamePromise

renamePromise(oldP: P, newP: P): Promise<void>

Overrides FakeFS.renamePromise
Parameters
- oldP: P
- newP: P
Returns Promise<void>

renameSync

renameSync(oldP: P, newP: P): void

Overrides FakeFS.renameSync
Parameters
- oldP: P
- newP: P
Returns void

resolve

resolve(path: P): P

Overrides FakeFS.resolve
Parameters
- path: P
Returns P

rmPromise

rmPromise(p: P, opts?: Partial<{ force: boolean; maxRetries: number; recursive: boolean; retryDelay: number }>): Promise<void>

Overrides FakeFS.rmPromise
Parameters
- p: P
- optionalopts: Partial<{ force: boolean; maxRetries: number; recursive: boolean; retryDelay: number }>
Returns Promise<void>

rmSync

rmSync(p: P, opts?: Partial<{ force: boolean; maxRetries: number; recursive: boolean; retryDelay: number }>): void

Overrides FakeFS.rmSync
Parameters
- p: P
- optionalopts: Partial<{ force: boolean; maxRetries: number; recursive: boolean; retryDelay: number }>
Returns void

rmdirPromise

rmdirPromise(p: P, opts?: Partial<{ maxRetries: number; recursive: boolean; retryDelay: number }>): Promise<void>

Overrides FakeFS.rmdirPromise
Parameters
- p: P
- optionalopts: Partial<{ maxRetries: number; recursive: boolean; retryDelay: number }>
Returns Promise<void>

rmdirSync

rmdirSync(p: P, opts?: Partial<{ maxRetries: number; recursive: boolean; retryDelay: number }>): void

Overrides FakeFS.rmdirSync
Parameters
- p: P
- optionalopts: Partial<{ maxRetries: number; recursive: boolean; retryDelay: number }>
Returns void

statPromise

statPromise(p: P): Promise<Stats>
statPromise(p: P, opts: undefined | (StatOptions & { bigint?: false })): Promise<Stats>
statPromise(p: P, opts: StatOptions & { bigint: true }): Promise<BigIntStats>

Overrides FakeFS.statPromise
Parameters
- p: P
Returns Promise<Stats>

statSync

statSync(p: P): Stats
statSync(p: P, opts?: StatSyncOptions & { bigint?: false; throwIfNoEntry: false }): undefined | Stats
statSync(p: P, opts: StatSyncOptions & { bigint: true; throwIfNoEntry: false }): undefined | BigIntStats
statSync(p: P, opts?: StatSyncOptions & { bigint?: false }): Stats
statSync(p: P, opts: StatSyncOptions & { bigint: true }): BigIntStats
statSync(p: P, opts: StatSyncOptions & { bigint: boolean; throwIfNoEntry?: false }): Stats | BigIntStats

Overrides FakeFS.statSync
Parameters
- p: P
Returns Stats

symlinkPromise

symlinkPromise(target: P, p: P, type?: SymlinkType): Promise<void>

Overrides FakeFS.symlinkPromise
Parameters
- target: P
- p: P
- optionaltype: SymlinkType
Returns Promise<void>

symlinkSync

symlinkSync(target: P, p: P, type?: SymlinkType): void

Overrides FakeFS.symlinkSync
Parameters
- target: P
- p: P
- optionaltype: SymlinkType
Returns void

truncatePromise

truncatePromise(p: P, len?: number): Promise<void>

Overrides FakeFS.truncatePromise
Parameters
- p: P
- optionallen: number
Returns Promise<void>

truncateSync

truncateSync(p: P, len?: number): void

Overrides FakeFS.truncateSync
Parameters
- p: P
- optionallen: number
Returns void

unlinkPromise

unlinkPromise(p: P): Promise<void>

Overrides FakeFS.unlinkPromise
Parameters
- p: P
Returns Promise<void>

unlinkSync

unlinkSync(p: P): void

Overrides FakeFS.unlinkSync
Parameters
- p: P
Returns void

unwatchFile

unwatchFile(p: P, cb?: WatchFileCallback): void

Overrides FakeFS.unwatchFile
Parameters
- p: P
- optionalcb: WatchFileCallback
Returns void

utimesPromise

utimesPromise(p: P, atime: string | number | Date, mtime: string | number | Date): Promise<void>

Overrides FakeFS.utimesPromise
Parameters
- p: P
- atime: string | number | Date
- mtime: string | number | Date
Returns Promise<void>

utimesSync

utimesSync(p: P, atime: string | number | Date, mtime: string | number | Date): void

Overrides FakeFS.utimesSync
Parameters
- p: P
- atime: string | number | Date
- mtime: string | number | Date
Returns void

watch

watch(p: P, cb?: WatchCallback): Watcher
watch(p: P, opts: WatchOptions, cb?: WatchCallback): Watcher

Overrides FakeFS.watch
Parameters
- p: P
- optionalcb: WatchCallback
Returns Watcher

watchFile

watchFile(p: P, cb: WatchFileCallback): StatWatcher
watchFile(p: P, opts: Partial<{ bigint: boolean; interval: number; persistent: boolean }>, cb: WatchFileCallback): StatWatcher

Overrides FakeFS.watchFile
Parameters
- p: P
- cb: WatchFileCallback
Returns StatWatcher

writeFilePromise

writeFilePromise(p: FSPath, content: string | ArrayBufferView, opts?: WriteFileOptions): Promise<void>

Overrides FakeFS.writeFilePromise
Parameters
- p: FSPath
- content: string | ArrayBufferView
- optionalopts: WriteFileOptions
Returns Promise<void>

writeFileSync

writeFileSync(p: FSPath, content: string | ArrayBufferView, opts?: WriteFileOptions): void

Overrides FakeFS.writeFileSync
Parameters
- p: FSPath
- content: string | ArrayBufferView
- optionalopts: WriteFileOptions
Returns void

writeJsonPromise

writeJsonPromise(p: P, data: any, __namedParameters?: { compact?: boolean }): Promise<void>

Inherited from FakeFS.writeJsonPromise
Parameters
- p: P
- data: any
- __namedParameters: { compact?: boolean } = {}
Returns Promise<void>

writeJsonSync

writeJsonSync(p: P, data: any, __namedParameters?: { compact?: boolean }): void

Inherited from FakeFS.writeJsonSync
Parameters
- p: P
- data: any
- __namedParameters: { compact?: boolean } = {}
Returns void

writePromise

writePromise(fd: number, buffer: Buffer, offset?: number, length?: number, position?: number): Promise<number>
writePromise(fd: number, buffer: string, position?: number): Promise<number>

Overrides FakeFS.writePromise
Parameters
- fd: number
- buffer: Buffer
- optionaloffset: number
- optionallength: number
- optionalposition: number
Returns Promise<number>

writeSync

writeSync(fd: number, buffer: Buffer, offset?: number, length?: number, position?: number): number
writeSync(fd: number, buffer: string, position?: number): number

Overrides FakeFS.writeSync
Parameters
- fd: number
- buffer: Buffer
- optionaloffset: number
- optionallength: number
- optionalposition: number
Returns number

Hierarchy

Index

Properties

Methods

Properties

publicreadonlypathUtils

Methods

accessPromise

Parameters

p: P

optionalmode: number

Returns Promise<void>

accessSync

Parameters

p: P

optionalmode: number

Returns void

appendFilePromise

Parameters

p: FSPath<P>

content: string | Uint8Array

optionalopts: WriteFileOptions

Returns Promise<void>

appendFileSync

Parameters

p: FSPath<P>

content: string | Uint8Array

optionalopts: WriteFileOptions

Returns void

changeFilePromise

Parameters

p: P

content: Buffer

Returns Promise<void>

changeFileSync

Parameters

p: P

content: Buffer

Returns void

checksumFilePromise

Parameters

path: P

__namedParameters: { algorithm?: string } = {}

Returns Promise<string>

chmodPromise

Parameters

p: P

mask: number

Returns Promise<void>

chmodSync

Parameters

p: P

mask: number

Returns void

chownPromise

Parameters

p: P

uid: number

gid: number

Returns Promise<void>

chownSync

Parameters

p: P

uid: number

gid: number

Returns void

closePromise

Parameters

fd: number

Returns Promise<void>

closeSync

Parameters

fd: number

Returns void

copyFilePromise

Parameters

sourceP: P

destP: P

flags: number = 0

Returns Promise<void>