NodeModulesFS
Hierarchy
- ProxiedFS<NativePath, PortablePath>
- NodeModulesFS
Index
Constructors
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
Constructors
constructor
Parameters
pnp: PnpApi
__namedParameters: NodeModulesFSOptions = {}
Returns NodeModulesFS
Properties
publicreadonlypathUtils
Methods
accessPromise
Parameters
p: NativePath
optionalmode: number
Returns Promise<void>
accessSync
Parameters
p: NativePath
optionalmode: number
Returns void
appendFilePromise
Parameters
p: FSPath<NativePath>
content: string | Uint8Array
optionalopts: WriteFileOptions
Returns Promise<void>
appendFileSync
Parameters
p: FSPath<NativePath>
content: string | Uint8Array
optionalopts: WriteFileOptions
Returns void
changeFilePromise
Parameters
p: NativePath
content: Buffer
Returns Promise<void>
changeFileSync
Parameters
p: NativePath
content: Buffer
Returns void
checksumFilePromise
Parameters
path: NativePath
__namedParameters: { algorithm?: string } = {}
Returns Promise<string>
chmodPromise
Parameters
p: NativePath
mask: number
Returns Promise<void>
chmodSync
Parameters
p: NativePath
mask: number
Returns void
chownPromise
Parameters
p: NativePath
uid: number
gid: number
Returns Promise<void>
chownSync
Parameters
p: NativePath
uid: number
gid: number
Returns void
closePromise
Parameters
fd: number
Returns Promise<void>
closeSync
Parameters
fd: number
Returns void
copyFilePromise
Parameters
sourceP: NativePath
destP: NativePath
flags: number = 0
Returns Promise<void>
copyFileSync
Parameters
sourceP: NativePath
destP: NativePath
flags: number = 0
Returns void
copyPromise
Parameters
destination: NativePath
source: NativePath
optionaloptions: { baseFs?: undefined; linkStrategy?: null | LinkStrategy<NativePath>; overwrite?: boolean; stableSort?: boolean; stableTime?: boolean }
Returns Promise<void>
copySync
Parameters
destination: NativePath
source: NativePath
optionaloptions: { baseFs?: undefined; overwrite?: boolean }
Returns void
createReadStream
Parameters
p: null | NativePath
optionalopts: Partial<{ encoding: BufferEncoding; fd: number }>
Returns ReadStream
createWriteStream
Parameters
p: null | NativePath
optionalopts: Partial<{ encoding: BufferEncoding; fd: number; flags: a }>
Returns WriteStream
existsPromise
Parameters
p: NativePath
Returns Promise<boolean>
existsSync
Parameters
p: NativePath
Returns boolean
fchmodPromise
Parameters
fd: number
mask: number
Returns Promise<void>
fchmodSync
Parameters
fd: number
mask: number
Returns void
fchownPromise
Parameters
fd: number
uid: number
gid: number
Returns Promise<void>
fchownSync
Parameters
fd: number
uid: number
gid: number
Returns void
fstatPromise
Parameters
fd: number
Returns Promise<Stats>
fstatSync
Parameters
fd: number
Returns Stats
ftruncatePromise
Parameters
fd: number
optionallen: number
Returns Promise<void>
ftruncateSync
Parameters
fd: number
optionallen: number
Returns void
genTraversePromise
Parameters
init: NativePath
__namedParameters: { stableSort?: boolean } = {}
Returns AsyncGenerator<NativePath, void, unknown>
getExtractHint
@deprecated: Moved to jsInstallUtils
Parameters
hints: ExtractHintOptions
Returns boolean
getRealPath
Returns NativePath
linkPromise
Parameters
existingP: NativePath
newP: NativePath
Returns Promise<void>
linkSync
Parameters
existingP: NativePath
newP: NativePath
Returns void
lockPromise
Type parameters
- T
Parameters
affectedPath: NativePath
callback: () => Promise<T>
Returns Promise<T>
lstatPromise
Parameters
p: NativePath
Returns Promise<Stats>
lstatSync
Parameters
p: NativePath
Returns Stats
lutimesPromise
Parameters
p: NativePath
atime: string | number | Date
mtime: string | number | Date
Returns Promise<void>
lutimesSync
Parameters
p: NativePath
atime: string | number | Date
mtime: string | number | Date
Returns void
mkdirPromise
Parameters
p: NativePath
optionalopts: Partial<{ mode: number; recursive: boolean }>
Returns Promise<undefined | string>
mkdirSync
Parameters
p: NativePath
optionalopts: Partial<{ mode: number; recursive: boolean }>
Returns undefined | string
mkdirpPromise
Parameters
p: NativePath
__namedParameters: { chmod?: number; utimes?: [string | number | Date, string | number | Date] } = {}
Returns Promise<undefined | string>
mkdirpSync
Parameters
p: NativePath
__namedParameters: { chmod?: number; utimes?: [string | number | Date, string | number | Date] } = {}
Returns undefined | string
movePromise
Parameters
fromP: NativePath
toP: NativePath
Returns Promise<void>
moveSync
Parameters
fromP: NativePath
toP: NativePath
Returns void
openPromise
Parameters
p: NativePath
flags: string
optionalmode: number
Returns Promise<number>
openSync
Parameters
p: NativePath
flags: string
optionalmode: number
Returns number
opendirPromise
Parameters
p: NativePath
optionalopts: Partial<{ bufferSize: number; recursive: boolean }>
Returns Promise<Dir<NativePath>>
opendirSync
Parameters
p: NativePath
optionalopts: Partial<{ bufferSize: number; recursive: boolean }>
Returns Dir<NativePath>
preserveTimePromise
Parameters
p: NativePath
cb: () => Promise<void | NativePath>
Returns Promise<void>
preserveTimeSync
Parameters
p: NativePath
cb: () => void | NativePath
Returns Promise<void>
readFilePromise
Parameters
p: FSPath<NativePath>
optionalencoding: null
Returns Promise<Buffer>
readFileSync
Parameters
p: FSPath<NativePath>
optionalencoding: null
Returns Buffer
readJsonPromise
Parameters
p: NativePath
Returns Promise<any>
readJsonSync
Parameters
p: NativePath
Returns any
readPromise
Parameters
fd: number
buffer: Buffer
optionaloffset: number
optionallength: number
optionalposition: null | number
Returns Promise<number>
readSync
Parameters
fd: number
buffer: Buffer
offset: number
length: number
position: number
Returns number
readdirPromise
Parameters
p: NativePath
optionalopts: null
Returns Promise<Filename[]>
readdirSync
Parameters
p: NativePath
optionalopts: null
Returns Filename[]
readlinkPromise
Parameters
p: NativePath
Returns Promise<NativePath>
readlinkSync
Parameters
p: NativePath
Returns NativePath
realpathPromise
Parameters
p: NativePath
Returns Promise<NativePath>
realpathSync
Parameters
p: NativePath
Returns NativePath
removePromise
Parameters
p: NativePath
__namedParameters: { maxRetries?: number; recursive?: boolean } = {}
Returns Promise<void>
removeSync
Parameters
p: NativePath
__namedParameters: { recursive?: boolean } = {}
Returns void
renamePromise
Parameters
oldP: NativePath
newP: NativePath
Returns Promise<void>
renameSync
Parameters
oldP: NativePath
newP: NativePath
Returns void
resolve
Parameters
path: NativePath
Returns NativePath
rmPromise
Parameters
p: NativePath
optionalopts: Partial<{ force: boolean; maxRetries: number; recursive: boolean; retryDelay: number }>
Returns Promise<void>
rmSync
Parameters
p: NativePath
optionalopts: Partial<{ force: boolean; maxRetries: number; recursive: boolean; retryDelay: number }>
Returns void
rmdirPromise
Parameters
p: NativePath
optionalopts: Partial<{ maxRetries: number; recursive: boolean; retryDelay: number }>
Returns Promise<void>
rmdirSync
Parameters
p: NativePath
optionalopts: Partial<{ maxRetries: number; recursive: boolean; retryDelay: number }>
Returns void
statPromise
Parameters
p: NativePath
Returns Promise<Stats>
statSync
Parameters
p: NativePath
Returns Stats
symlinkPromise
Parameters
target: NativePath
p: NativePath
optionaltype: SymlinkType
Returns Promise<void>
symlinkSync
Parameters
target: NativePath
p: NativePath
optionaltype: SymlinkType
Returns void
truncatePromise
Parameters
p: NativePath
optionallen: number
Returns Promise<void>
truncateSync
Parameters
p: NativePath
optionallen: number
Returns void
unlinkPromise
Parameters
p: NativePath
Returns Promise<void>
unlinkSync
Parameters
p: NativePath
Returns void
unwatchFile
Parameters
p: NativePath
optionalcb: WatchFileCallback
Returns void
utimesPromise
Parameters
p: NativePath
atime: string | number | Date
mtime: string | number | Date
Returns Promise<void>
utimesSync
Parameters
p: NativePath
atime: string | number | Date
mtime: string | number | Date
Returns void
watch
Parameters
p: NativePath
optionalcb: WatchCallback
Returns Watcher
watchFile
Parameters
p: NativePath
cb: WatchFileCallback
Returns StatWatcher
writeFilePromise
Parameters
p: FSPath<NativePath>
content: string | ArrayBufferView
optionalopts: WriteFileOptions
Returns Promise<void>
writeFileSync
Parameters
p: FSPath<NativePath>
content: string | ArrayBufferView
optionalopts: WriteFileOptions
Returns void
writeJsonPromise
Parameters
p: NativePath
data: any
__namedParameters: { compact?: boolean } = {}
Returns Promise<void>
writeJsonSync
Parameters
p: NativePath
data: any
__namedParameters: { compact?: boolean } = {}
Returns void
writePromise
Parameters
fd: number
buffer: Buffer
optionaloffset: number
optionallength: number
optionalposition: number
Returns Promise<number>
writeSync
Parameters
fd: number
buffer: Buffer
optionaloffset: number
optionallength: number
optionalposition: number
Returns number
Prefer using
copyPromise
instead