abstractFakeFS <P>
Hierarchy
Index
Properties
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
Methods
abstractaccessPromise
Parameters
p: P
optionalmode: number
Returns Promise<void>
abstractaccessSync
Parameters
p: P
optionalmode: number
Returns void
abstractappendFilePromise
Parameters
p: FSPath<P>
content: string | Uint8Array
optionalopts: WriteFileOptions
Returns Promise<void>
abstractappendFileSync
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>
abstractchmodPromise
Parameters
p: P
mask: number
Returns Promise<void>
abstractchmodSync
Parameters
p: P
mask: number
Returns void
abstractchownPromise
Parameters
p: P
uid: number
gid: number
Returns Promise<void>
abstractchownSync
Parameters
p: P
uid: number
gid: number
Returns void
abstractclosePromise
Parameters
fd: number
Returns Promise<void>
abstractcloseSync
Parameters
fd: number
Returns void
abstractcopyFilePromise
Parameters
sourceP: P
destP: P
optionalflags: number
Returns Promise<void>
abstractcopyFileSync
Parameters
sourceP: P
destP: P
optionalflags: number
Returns void
copyPromise
Parameters
destination: P
source: P
optionaloptions: { baseFs?: undefined; linkStrategy?: null | LinkStrategy<P>; overwrite?: boolean; stableSort?: boolean; stableTime?: boolean }
Returns Promise<void>
copySync
Parameters
destination: P
source: P
optionaloptions: { baseFs?: undefined; overwrite?: boolean }
Returns void
abstractcreateReadStream
Parameters
p: null | P
optionalopts: Partial<{ encoding: BufferEncoding; fd: number }>
Returns ReadStream
abstractcreateWriteStream
Parameters
p: null | P
optionalopts: Partial<{ encoding: BufferEncoding; fd: number; flags: a }>
Returns WriteStream
abstractexistsPromise
Parameters
p: P
Returns Promise<boolean>
abstractexistsSync
Parameters
p: P
Returns boolean
abstractfchmodPromise
Parameters
fd: number
mask: number
Returns Promise<void>
abstractfchmodSync
Parameters
fd: number
mask: number
Returns void
abstractfchownPromise
Parameters
fd: number
uid: number
gid: number
Returns Promise<void>
abstractfchownSync
Parameters
fd: number
uid: number
gid: number
Returns void
abstractfstatPromise
Parameters
fd: number
Returns Promise<Stats>
abstractfstatSync
Parameters
fd: number
Returns Stats
abstractftruncatePromise
Parameters
fd: number
optionallen: number
Returns Promise<void>
abstractftruncateSync
Parameters
fd: number
optionallen: number
Returns void
genTraversePromise
Parameters
init: P
__namedParameters: { stableSort?: boolean } = {}
Returns AsyncGenerator<P, void, unknown>
abstractgetExtractHint
@deprecated: Moved to jsInstallUtils
Parameters
hints: ExtractHintOptions
Returns boolean
abstractgetRealPath
Returns P
abstractlinkPromise
Parameters
existingP: P
newP: P
Returns Promise<void>
abstractlinkSync
Parameters
existingP: P
newP: P
Returns void
lockPromise
Type parameters
- T
Parameters
affectedPath: P
callback: () => Promise<T>
Returns Promise<T>
abstractlstatPromise
Parameters
p: P
Returns Promise<Stats>
abstractlstatSync
Parameters
p: P
Returns Stats
abstractlutimesPromise
Parameters
p: P
atime: string | number | Date
mtime: string | number | Date
Returns Promise<void>
abstractlutimesSync
Parameters
p: P
atime: string | number | Date
mtime: string | number | Date
Returns void
abstractmkdirPromise
Parameters
p: P
optionalopts: Partial<{ mode: number; recursive: boolean }>
Returns Promise<undefined | string>
abstractmkdirSync
Parameters
p: P
optionalopts: Partial<{ mode: number; recursive: boolean }>
Returns undefined | string
mkdirpPromise
Parameters
p: P
__namedParameters: { chmod?: number; utimes?: [string | number | Date, string | number | Date] } = {}
Returns Promise<undefined | string>
mkdirpSync
Parameters
p: P
__namedParameters: { chmod?: number; utimes?: [string | number | Date, string | number | Date] } = {}
Returns undefined | string
movePromise
Parameters
fromP: P
toP: P
Returns Promise<void>
moveSync
Parameters
fromP: P
toP: P
Returns void
abstractopenPromise
Parameters
p: P
flags: string
optionalmode: number
Returns Promise<number>
abstractopenSync
Parameters
p: P
flags: string
optionalmode: number
Returns number
abstractopendirPromise
Parameters
p: P
optionalopts: Partial<{ bufferSize: number; recursive: boolean }>
Returns Promise<Dir<P>>
abstractopendirSync
Parameters
p: P
optionalopts: Partial<{ bufferSize: number; recursive: boolean }>
Returns Dir<P>
preserveTimePromise
Parameters
p: P
cb: () => Promise<void | P>
Returns Promise<void>
preserveTimeSync
Parameters
p: P
cb: () => void | P
Returns Promise<void>
abstractreadFilePromise
Parameters
p: FSPath<P>
optionalencoding: null
Returns Promise<Buffer>
abstractreadFileSync
Parameters
p: FSPath<P>
optionalencoding: null
Returns Buffer
readJsonPromise
Parameters
p: P
Returns Promise<any>
readJsonSync
Parameters
p: P
Returns any
abstractreadPromise
Parameters
fd: number
buffer: Buffer
optionaloffset: number
optionallength: number
optionalposition: null | number
Returns Promise<number>
abstractreadSync
Parameters
fd: number
buffer: Buffer
optionaloffset: number
optionallength: number
optionalposition: null | number
Returns number
abstractreaddirPromise
Parameters
p: P
optionalopts: null
Returns Promise<Filename[]>
abstractreaddirSync
Parameters
p: P
optionalopts: null
Returns Filename[]
abstractreadlinkPromise
Parameters
p: P
Returns Promise<P>
abstractreadlinkSync
Parameters
p: P
Returns P
abstractrealpathPromise
Parameters
p: P
Returns Promise<P>
abstractrealpathSync
Parameters
p: P
Returns P
removePromise
Parameters
p: P
__namedParameters: { maxRetries?: number; recursive?: boolean } = {}
Returns Promise<void>
removeSync
Parameters
p: P
__namedParameters: { recursive?: boolean } = {}
Returns void
abstractrenamePromise
Parameters
oldP: P
newP: P
Returns Promise<void>
abstractrenameSync
Parameters
oldP: P
newP: P
Returns void
abstractresolve
Parameters
p: P
Returns P
abstractrmPromise
Parameters
p: P
optionalopts: Partial<{ force: boolean; maxRetries: number; recursive: boolean; retryDelay: number }>
Returns Promise<void>
abstractrmSync
Parameters
p: P
optionalopts: Partial<{ force: boolean; maxRetries: number; recursive: boolean; retryDelay: number }>
Returns void
abstractrmdirPromise
Parameters
p: P
optionalopts: Partial<{ maxRetries: number; recursive: boolean; retryDelay: number }>
Returns Promise<void>
abstractrmdirSync
Parameters
p: P
optionalopts: Partial<{ maxRetries: number; recursive: boolean; retryDelay: number }>
Returns void
abstractstatPromise
Parameters
p: P
Returns Promise<Stats>
abstractstatSync
Parameters
p: P
Returns Stats
abstractsymlinkPromise
Parameters
target: P
p: P
optionaltype: SymlinkType
Returns Promise<void>
abstractsymlinkSync
Parameters
target: P
p: P
optionaltype: SymlinkType
Returns void
abstracttruncatePromise
Parameters
p: P
optionallen: number
Returns Promise<void>
abstracttruncateSync
Parameters
p: P
optionallen: number
Returns void
abstractunlinkPromise
Parameters
p: P
Returns Promise<void>
abstractunlinkSync
Parameters
p: P
Returns void
abstractunwatchFile
Parameters
p: P
optionalcb: WatchFileCallback
Returns void
abstractutimesPromise
Parameters
p: P
atime: string | number | Date
mtime: string | number | Date
Returns Promise<void>
abstractutimesSync
Parameters
p: P
atime: string | number | Date
mtime: string | number | Date
Returns void
abstractwatch
Parameters
p: P
optionalcb: WatchCallback
Returns Watcher
abstractwatchFile
Parameters
p: P
cb: WatchFileCallback
Returns StatWatcher
abstractwriteFilePromise
Parameters
p: FSPath<P>
content: string | ArrayBufferView
optionalopts: WriteFileOptions
Returns Promise<void>
abstractwriteFileSync
Parameters
p: FSPath<P>
content: string | ArrayBufferView
optionalopts: WriteFileOptions
Returns void
writeJsonPromise
Parameters
p: P
data: any
__namedParameters: { compact?: boolean } = {}
Returns Promise<void>
writeJsonSync
Parameters
p: P
data: any
__namedParameters: { compact?: boolean } = {}
Returns void
abstractwritePromise
Parameters
fd: number
buffer: Buffer
optionaloffset: number
optionallength: number
optionalposition: number
Returns Promise<number>
abstractwriteSync
Parameters
fd: number
buffer: Buffer
optionaloffset: number
optionallength: number
optionalposition: number
Returns number
Prefer using
copyPromise
instead