Globals

Class NodeFS

Hierarchy

BasePortableFakeFS
- NodeFS

Constructors

constructor

Properties

Methods

Constructors

constructor

new NodeFS(realFs?: typeof fs): NodeFS

Overrides BasePortableFakeFS.constructor
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:10
Parameters
- Default value realFs: typeof fs = fs
Returns NodeFS

Properties

pathUtils

pathUtils: PathUtils<PortablePath>

Private realFs

realFs: typeof fs

Methods

accessPromise

accessPromise(p: PortablePath, mode?: undefined | number): Promise<void>

Overrides FakeFS.accessPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:140
Parameters
- p: PortablePath
- Optional mode: undefined | number
Returns Promise<void>

accessSync

accessSync(p: PortablePath, mode?: undefined | number): void

Overrides FakeFS.accessSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:136
Parameters
- p: PortablePath
- Optional mode: undefined | number
Returns void

appendFilePromise

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

Overrides FakeFS.appendFilePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:292
Parameters
- p: FSPath<PortablePath>
- content: string | Uint8Array
- Optional opts: WriteFileOptions
Returns Promise<void>

appendFileSync

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

Overrides FakeFS.appendFileSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:303
Parameters
- p: PortablePath
- content: string | Uint8Array
- Optional opts: WriteFileOptions
Returns void

changeFilePromise

changeFilePromise(p: PortablePath, content: Buffer): Promise<void>
changeFilePromise(p: PortablePath, content: string, opts?: ChangeFileOptions): Promise<void>

Inherited from FakeFS.changeFilePromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:512
Parameters
- p: PortablePath
- content: Buffer
Returns Promise<void>
Inherited from FakeFS.changeFilePromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:513
Parameters
- p: PortablePath
- content: string
- Optional opts: ChangeFileOptions
Returns Promise<void>

changeFileSync

changeFileSync(p: PortablePath, content: Buffer): void
changeFileSync(p: PortablePath, content: string, opts?: ChangeFileOptions): void

Inherited from FakeFS.changeFileSync
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:554
Parameters
- p: PortablePath
- content: Buffer
Returns void
Inherited from FakeFS.changeFileSync
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:555
Parameters
- p: PortablePath
- content: string
- Optional opts: ChangeFileOptions
Returns void

checksumFilePromise

checksumFilePromise(path: PortablePath, __namedParameters?: object): Promise<string>

Inherited from FakeFS.checksumFilePromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:308
Parameters
- path: PortablePath
- Default value __namedParameters: object = {}
  - algorithm: string
Returns Promise<string>

chmodPromise

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

Overrides FakeFS.chmodPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:242
Parameters
- p: PortablePath
- mask: number
Returns Promise<void>

chmodSync

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

Overrides FakeFS.chmodSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:248
Parameters
- p: PortablePath
- mask: number
Returns void

chownPromise

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

Overrides FakeFS.chownPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:262
Parameters
- p: PortablePath
- uid: number
- gid: number
Returns Promise<void>

chownSync

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

Overrides FakeFS.chownSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:268
Parameters
- p: PortablePath
- uid: number
- gid: number
Returns void

closePromise

closePromise(fd: number): Promise<void>

Overrides FakeFS.closePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:98
Parameters
- fd: number
Returns Promise<void>

closeSync

closeSync(fd: number): void

Overrides FakeFS.closeSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:104
Parameters
- fd: number
Returns void

copyFilePromise

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

Overrides FakeFS.copyFilePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:282
Parameters
- sourceP: PortablePath
- destP: PortablePath
- Default value flags: number = 0
Returns Promise<void>

copyFileSync

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

Overrides FakeFS.copyFileSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:288
Parameters
- sourceP: PortablePath
- destP: PortablePath
- Default value flags: number = 0
Returns void

copyPromise

copyPromise(destination: PortablePath, source: PortablePath, options?: undefined | object): Promise<void>
copyPromise<P2>(destination: PortablePath, source: P2, options: object): Promise<void>

Inherited from FakeFS.copyPromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:469
Parameters
- destination: PortablePath
- source: PortablePath
- Optional options: undefined | object
Returns Promise<void>
Inherited from FakeFS.copyPromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:470
Type parameters
- P2: Path
Parameters
- destination: PortablePath
- source: P2
- options: object
  - baseFs: FakeFS<P2>
  - Optional linkStrategy?: LinkStrategy<PortablePath> | null
  - Optional overwrite?: undefined | false | true
  - Optional stableSort?: undefined | false | true
  - Optional stableTime?: undefined | false | true
Returns Promise<void>

copySync

copySync(destination: PortablePath, source: PortablePath, options?: undefined | object): void
copySync<P2>(destination: PortablePath, source: P2, options: object): void

Inherited from FakeFS.copySync
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:476
deprecated

Prefer using copyPromise instead

Parameters
- destination: PortablePath
- source: PortablePath
- Optional options: undefined | object
Returns void
Inherited from FakeFS.copySync
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:477
Type parameters
- P2: Path
Parameters
- destination: PortablePath
- source: P2
- options: object
  - baseFs: FakeFS<P2>
  - Optional overwrite?: undefined | false | true
Returns void

createReadStream

createReadStream(p: PortablePath | null, opts?: CreateReadStreamOptions): ReadStream

Overrides FakeFS.createReadStream
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:108
Parameters
- p: PortablePath | null
- Optional opts: CreateReadStreamOptions
Returns ReadStream

createWriteStream

createWriteStream(p: PortablePath | null, opts?: CreateWriteStreamOptions): WriteStream

Overrides FakeFS.createWriteStream
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:113
Parameters
- p: PortablePath | null
- Optional opts: CreateWriteStreamOptions
Returns WriteStream

existsPromise

existsPromise(p: PortablePath): Promise<boolean>

Overrides FakeFS.existsPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:130
Parameters
- p: PortablePath
Returns Promise<boolean>

existsSync

existsSync(p: PortablePath): boolean

Overrides FakeFS.existsSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:146
Parameters
- p: PortablePath
Returns boolean

fchmodPromise

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

Overrides FakeFS.fchmodPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:232
Parameters
- fd: number
- mask: number
Returns Promise<void>

fchmodSync

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

Overrides FakeFS.fchmodSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:238
Parameters
- fd: number
- mask: number
Returns void

fchownPromise

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

Overrides FakeFS.fchownPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:252
Parameters
- fd: number
- uid: number
- gid: number
Returns Promise<void>

fchownSync

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

Overrides FakeFS.fchownSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:258
Parameters
- fd: number
- uid: number
- gid: number
Returns void

fstatPromise

fstatPromise(fd: number): Promise<Stats>
fstatPromise(fd: number, opts: object): Promise<BigIntStats>
fstatPromise(fd: number, opts?: undefined | object): Promise<BigIntStats | Stats>

Overrides FakeFS.fstatPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:179
Parameters
- fd: number
Returns Promise<Stats>
Overrides FakeFS.fstatPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:180
Parameters
- fd: number
- opts: object
  - bigint: true
Returns Promise<BigIntStats>
Overrides FakeFS.fstatPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:181
Parameters
- fd: number
- Optional opts: undefined | object
Returns Promise<BigIntStats | Stats>

fstatSync

fstatSync(fd: number): Stats
fstatSync(fd: number, opts: object): BigIntStats
fstatSync(fd: number, opts?: undefined | object): BigIntStats | Stats

Overrides FakeFS.fstatSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:192
Parameters
- fd: number
Returns Stats
Overrides FakeFS.fstatSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:193
Parameters
- fd: number
- opts: object
  - bigint: true
Returns BigIntStats
Overrides FakeFS.fstatSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:194
Parameters
- fd: number
- Optional opts: undefined | object
Returns BigIntStats | Stats

ftruncatePromise

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

Overrides FakeFS.ftruncatePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:473
Parameters
- fd: number
- Optional len: undefined | number
Returns Promise<void>

ftruncateSync

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

Overrides FakeFS.ftruncateSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:479
Parameters
- fd: number
- Optional len: undefined | number
Returns void

genTraversePromise

genTraversePromise(init: PortablePath, __namedParameters?: object): AsyncGenerator<P, void, unknown>

Inherited from FakeFS.genTraversePromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:286
Parameters
- init: PortablePath
- Default value __namedParameters: object = {}
  - stableSort: boolean
Returns AsyncGenerator<P, void, unknown>

getExtractHint

getExtractHint(): boolean

Overrides FakeFS.getExtractHint
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:18
Returns boolean

getRealPath

getRealPath(): string & object

Overrides FakeFS.getRealPath
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:22
Returns string & object

linkPromise

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

Overrides FakeFS.linkPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:387
Parameters
- existingP: PortablePath
- newP: PortablePath
Returns Promise<void>

linkSync

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

Overrides FakeFS.linkSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:393
Parameters
- existingP: PortablePath
- newP: PortablePath
Returns void

lockPromise

lockPromise<T>(affectedPath: PortablePath, callback: function): Promise<T>

Inherited from FakeFS.lockPromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:622
Type parameters
- T
Parameters
- affectedPath: PortablePath
- callback: function
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>

lstatPromise

lstatPromise(p: PortablePath): Promise<Stats>
lstatPromise(p: PortablePath, opts: StatOptions & object | undefined): Promise<Stats>
lstatPromise(p: PortablePath, opts: StatOptions & object): Promise<BigIntStats>

Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:204
Parameters
- p: PortablePath
Returns Promise<Stats>
Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:205
Parameters
- p: PortablePath
- opts: StatOptions & object | undefined
Returns Promise<Stats>
Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:206
Parameters
- p: PortablePath
- opts: StatOptions & object
Returns Promise<BigIntStats>

lstatSync

lstatSync(p: PortablePath): Stats
lstatSync(p: PortablePath, opts?: StatSyncOptions & object): Stats | undefined
lstatSync(p: PortablePath, opts: StatSyncOptions & object): BigIntStats | undefined
lstatSync(p: PortablePath, opts?: StatSyncOptions & object): Stats
lstatSync(p: PortablePath, opts: StatSyncOptions & object): BigIntStats
lstatSync(p: PortablePath, opts: StatSyncOptions & object): Stats | BigIntStats

Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:218
Parameters
- p: PortablePath
Returns Stats
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:219
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats | undefined
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:220
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats | undefined
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:221
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:222
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:223
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns Stats | BigIntStats

lutimesPromise

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

Overrides FakeFS.lutimesPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:352
Parameters
- p: PortablePath
- atime: Date | string | number
- mtime: Date | string | number
Returns Promise<void>

lutimesSync

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

Overrides FakeFS.lutimesSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:358
Parameters
- p: PortablePath
- atime: Date | string | number
- mtime: Date | string | number
Returns void

Private makeCallback

makeCallback<T>(resolve: function, reject: function): (Anonymous function)

- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:509
Type parameters
- T
Parameters
- resolve: function
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
- reject: function
  - - (reject: ErrnoException): void
    - Parameters
      - reject: ErrnoException
      Returns void
Returns (Anonymous function)

mkdirPromise

mkdirPromise(p: PortablePath, opts?: MkdirOptions): Promise<undefined | string>

Overrides FakeFS.mkdirPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:362
Parameters
- p: PortablePath
- Optional opts: MkdirOptions
Returns Promise<undefined | string>

mkdirSync

mkdirSync(p: PortablePath, opts?: MkdirOptions): string | undefined

Overrides FakeFS.mkdirSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:368
Parameters
- p: PortablePath
- Optional opts: MkdirOptions
Returns string | undefined

mkdirpPromise

mkdirpPromise(p: PortablePath, __namedParameters?: object): Promise<string | undefined>

Inherited from FakeFS.mkdirpPromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:389
Parameters
- p: PortablePath
- Default value __namedParameters: object = {}
  - chmod: undefined | number
  - utimes: undefined | [string | number | Date, string | number | Date]
Returns Promise<string | undefined>

mkdirpSync

mkdirpSync(p: PortablePath, __namedParameters?: object): string | undefined

Inherited from FakeFS.mkdirpSync
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:429
Parameters
- p: PortablePath
- Default value __namedParameters: object = {}
  - chmod: undefined | number
  - utimes: undefined | [string | number | Date, string | number | Date]
Returns string | undefined

movePromise

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

Inherited from FakeFS.movePromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:596
Parameters
- fromP: PortablePath
- toP: PortablePath
Returns Promise<void>

moveSync

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

Inherited from FakeFS.moveSync
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:609
Parameters
- fromP: PortablePath
- toP: PortablePath
Returns void

openPromise

openPromise(p: PortablePath, flags: string, mode?: undefined | number): Promise<number>

Overrides FakeFS.openPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:30
Parameters
- p: PortablePath
- flags: string
- Optional mode: undefined | number
Returns Promise<number>

openSync

openSync(p: PortablePath, flags: string, mode?: undefined | number): number

Overrides FakeFS.openSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:36
Parameters
- p: PortablePath
- flags: string
- Optional mode: undefined | number
Returns number

opendirPromise

opendirPromise(p: PortablePath, opts?: OpendirOptions): Promise<Dir<PortablePath>>

Overrides FakeFS.opendirPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:40
Parameters
- p: PortablePath
- Optional opts: OpendirOptions
Returns Promise<Dir<PortablePath>>

opendirSync

opendirSync(p: PortablePath, opts?: OpendirOptions): object

Overrides FakeFS.opendirSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:52
Parameters
- p: PortablePath
- Optional opts: OpendirOptions
Returns object
- path: P
- __computed: function
  - __computed(): AsyncIterableIterator<Dirent>
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:28
    Returns AsyncIterableIterator<Dirent>
- close: function
  - close(): Promise<void>
  - close(cb: NoParamCallback): void
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:30
    Returns Promise<void>
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:31
    Parameters
    - cb: NoParamCallback
    Returns void
- closeSync: function
  - closeSync(): void
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:33
    Returns void
- read: function
  - read(): Promise<Dirent | null>
  - read(cb: function): void
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:35
    Returns Promise<Dirent | null>
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:36
    Parameters
    - cb: function
      - (err: ErrnoException | null, dirent: Dirent | null): void
        
        Parameters
        
        err: ErrnoException | null
        
        dirent: Dirent | null
        
        Returns void
    Returns void
- readSync: function
  - readSync(): Dirent | null
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:38
    Returns Dirent | null

preserveTimePromise

preserveTimePromise(p: PortablePath, cb: function): Promise<void>

Inherited from FakeFS.preserveTimePromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:727
Parameters
- p: PortablePath
- cb: function
  - - (): Promise<PortablePath | void>
    - Returns Promise<PortablePath | void>
Returns Promise<void>

preserveTimeSync

preserveTimeSync(p: PortablePath, cb: function): Promise<void>

Inherited from FakeFS.preserveTimeSync
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:737
Parameters
- p: PortablePath
- cb: function
  - - (): PortablePath | void
    - Returns PortablePath | void
Returns Promise<void>

readFilePromise

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

Overrides FakeFS.readFilePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:407
Parameters
- p: FSPath<PortablePath>
- Optional encoding: undefined | null
Returns Promise<Buffer>
Overrides FakeFS.readFilePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:408
Parameters
- p: FSPath<PortablePath>
- encoding: BufferEncoding
Returns Promise<string>
Overrides FakeFS.readFilePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:409
Parameters
- p: FSPath<PortablePath>
- Optional encoding: BufferEncoding | null
Returns Promise<Buffer | string>

readFileSync

readFileSync(p: FSPath<PortablePath>, encoding?: undefined | null): Buffer
readFileSync(p: FSPath<PortablePath>, encoding: BufferEncoding): string
readFileSync(p: FSPath<PortablePath>, encoding?: BufferEncoding | null): Buffer | string

Overrides FakeFS.readFileSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:417
Parameters
- p: FSPath<PortablePath>
- Optional encoding: undefined | null
Returns Buffer
Overrides FakeFS.readFileSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:418
Parameters
- p: FSPath<PortablePath>
- encoding: BufferEncoding
Returns string
Overrides FakeFS.readFileSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:419
Parameters
- p: FSPath<PortablePath>
- Optional encoding: BufferEncoding | null
Returns Buffer | string

readJsonPromise

readJsonPromise(p: PortablePath): Promise<any>

Inherited from FakeFS.readJsonPromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:697
Parameters
- p: PortablePath
Returns Promise<any>

readJsonSync

readJsonSync(p: PortablePath): any

Inherited from FakeFS.readJsonSync
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:708
Parameters
- p: PortablePath
Returns any

readPromise

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

Overrides FakeFS.readPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:60
Parameters
- fd: number
- buffer: Buffer
- Default value offset: number = 0
- Default value length: number = 0
- Default value position: number | null = -1
Returns Promise<number>

readSync

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

Overrides FakeFS.readSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:72
Parameters
- fd: number
- buffer: Buffer
- offset: number
- length: number
- position: number
Returns number

readdirPromise

readdirPromise(p: PortablePath): Promise<Array<Filename>>
readdirPromise(p: PortablePath, opts: object | null): Promise<Array<Filename>>
readdirPromise(p: PortablePath, opts: object): Promise<Array<Dirent>>
readdirPromise(p: PortablePath, opts: object): Promise<Array<Filename> | Array<Dirent>>

Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:425
Parameters
- p: PortablePath
Returns Promise<Array<Filename>>
Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:426
Parameters
- p: PortablePath
- opts: object | null
Returns Promise<Array<Filename>>
Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:427
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: true
Returns Promise<Array<Dirent>>
Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:428
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: boolean
Returns Promise<Array<Filename> | Array<Dirent>>

readdirSync

readdirSync(p: PortablePath): Array<Filename>
readdirSync(p: PortablePath, opts: object | null): Array<Filename>
readdirSync(p: PortablePath, opts: object): Array<Dirent>
readdirSync(p: PortablePath, opts: object): Array<Filename> | Array<Dirent>

Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:439
Parameters
- p: PortablePath
Returns Array<Filename>
Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:440
Parameters
- p: PortablePath
- opts: object | null
Returns Array<Filename>
Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:441
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: true
Returns Array<Dirent>
Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:442
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: boolean
Returns Array<Filename> | Array<Dirent>

readlinkPromise

readlinkPromise(p: PortablePath): Promise<string & object>

Overrides FakeFS.readlinkPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:451
Parameters
- p: PortablePath
Returns Promise<string & object>

readlinkSync

readlinkSync(p: PortablePath): string & object

Overrides FakeFS.readlinkSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:459
Parameters
- p: PortablePath
Returns string & object

realpathPromise

realpathPromise(p: PortablePath): Promise<string & object>

Overrides FakeFS.realpathPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:118
Parameters
- p: PortablePath
Returns Promise<string & object>

realpathSync

realpathSync(p: PortablePath): string & object

Overrides FakeFS.realpathSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:126
Parameters
- p: PortablePath
Returns string & object

removePromise

removePromise(p: PortablePath, __namedParameters?: object): Promise<void>

Inherited from FakeFS.removePromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:327
Parameters
- p: PortablePath
- Default value __namedParameters: object = {}
  - maxRetries: number
  - recursive: boolean
Returns Promise<void>

removeSync

removeSync(p: PortablePath, __namedParameters?: object): void

Inherited from FakeFS.removeSync
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:366
Parameters
- p: PortablePath
- Default value __namedParameters: object = {}
  - recursive: boolean
Returns void

renamePromise

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

Overrides FakeFS.renamePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:272
Parameters
- oldP: PortablePath
- newP: PortablePath
Returns Promise<void>

renameSync

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

Overrides FakeFS.renameSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:278
Parameters
- oldP: PortablePath
- newP: PortablePath
Returns void

resolve

resolve(p: PortablePath): string & object

Overrides FakeFS.resolve
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:26
Parameters
- p: PortablePath
Returns string & object

rmdirPromise

rmdirPromise(p: PortablePath, opts?: RmdirOptions): Promise<void>

Overrides FakeFS.rmdirPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:372
Parameters
- p: PortablePath
- Optional opts: RmdirOptions
Returns Promise<void>

rmdirSync

rmdirSync(p: PortablePath, opts?: RmdirOptions): void

Overrides FakeFS.rmdirSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:383
Parameters
- p: PortablePath
- Optional opts: RmdirOptions
Returns void

statPromise

statPromise(p: PortablePath): Promise<Stats>
statPromise(p: PortablePath, opts: StatOptions & object | undefined): Promise<Stats>
statPromise(p: PortablePath, opts: StatOptions & object): Promise<BigIntStats>

Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:151
Parameters
- p: PortablePath
Returns Promise<Stats>
Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:152
Parameters
- p: PortablePath
- opts: StatOptions & object | undefined
Returns Promise<Stats>
Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:153
Parameters
- p: PortablePath
- opts: StatOptions & object
Returns Promise<BigIntStats>

statSync

statSync(p: PortablePath): Stats
statSync(p: PortablePath, opts?: StatSyncOptions & object): Stats | undefined
statSync(p: PortablePath, opts: StatSyncOptions & object): BigIntStats | undefined
statSync(p: PortablePath, opts?: StatSyncOptions & object): Stats
statSync(p: PortablePath, opts: StatSyncOptions & object): BigIntStats
statSync(p: PortablePath, opts: StatSyncOptions & object): Stats | BigIntStats

Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:165
Parameters
- p: PortablePath
Returns Stats
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:166
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats | undefined
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:167
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats | undefined
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:168
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:169
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:170
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns Stats | BigIntStats

symlinkPromise

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

Overrides FakeFS.symlinkPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:397
Parameters
- target: PortablePath
- p: PortablePath
- Optional type: SymlinkType
Returns Promise<void>

symlinkSync

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

Overrides FakeFS.symlinkSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:403
Parameters
- target: PortablePath
- p: PortablePath
- Optional type: SymlinkType
Returns void

truncatePromise

truncatePromise(p: PortablePath, len?: undefined | number): Promise<void>

Overrides FakeFS.truncatePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:463
Parameters
- p: PortablePath
- Optional len: undefined | number
Returns Promise<void>

truncateSync

truncateSync(p: PortablePath, len?: undefined | number): void

Overrides FakeFS.truncateSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:469
Parameters
- p: PortablePath
- Optional len: undefined | number
Returns void

unlinkPromise

unlinkPromise(p: PortablePath): Promise<void>

Overrides FakeFS.unlinkPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:332
Parameters
- p: PortablePath
Returns Promise<void>

unlinkSync

unlinkSync(p: PortablePath): void

Overrides FakeFS.unlinkSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:338
Parameters
- p: PortablePath
Returns void

unwatchFile

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

Overrides FakeFS.unwatchFile
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:505
Parameters
- p: PortablePath
- Optional cb: WatchFileCallback
Returns void

utimesPromise

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

Overrides FakeFS.utimesPromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:342
Parameters
- p: PortablePath
- atime: Date | string | number
- mtime: Date | string | number
Returns Promise<void>

utimesSync

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

Overrides FakeFS.utimesSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:348
Parameters
- p: PortablePath
- atime: Date | string | number
- mtime: Date | string | number
Returns void

watch

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

Overrides FakeFS.watch
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:483
Parameters
- p: PortablePath
- Optional cb: WatchCallback
Returns Watcher
Overrides FakeFS.watch
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:484
Parameters
- p: PortablePath
- opts: WatchOptions
- Optional cb: WatchCallback
Returns Watcher

watchFile

watchFile(p: PortablePath, cb: WatchFileCallback): StatWatcher
watchFile(p: PortablePath, opts: WatchFileOptions, cb: WatchFileCallback): StatWatcher

Overrides FakeFS.watchFile
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:494
Parameters
- p: PortablePath
- cb: WatchFileCallback
Returns StatWatcher
Overrides FakeFS.watchFile
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:495
Parameters
- p: PortablePath
- opts: WatchFileOptions
- cb: WatchFileCallback
Returns StatWatcher

writeFilePromise

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

Overrides FakeFS.writeFilePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:312
Parameters
- p: FSPath<PortablePath>
- content: string | NodeJS.ArrayBufferView
- Optional opts: WriteFileOptions
Returns Promise<void>

writeFileSync

writeFileSync(p: PortablePath, content: string | NodeJS.ArrayBufferView, opts?: WriteFileOptions): void

Overrides FakeFS.writeFileSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:323
Parameters
- p: PortablePath
- content: string | NodeJS.ArrayBufferView
- Optional opts: WriteFileOptions
Returns void

writeJsonPromise

writeJsonPromise(p: PortablePath, data: any): Promise<void>

Inherited from FakeFS.writeJsonPromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:719
Parameters
- p: PortablePath
- data: any
Returns Promise<void>

writeJsonSync

writeJsonSync(p: PortablePath, data: any): void

Inherited from FakeFS.writeJsonSync
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:723
Parameters
- p: PortablePath
- data: any
Returns void

writePromise

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

Overrides FakeFS.writePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:76
Parameters
- fd: number
- buffer: Buffer
- Optional offset: undefined | number
- Optional length: undefined | number
- Optional position: undefined | number
Returns Promise<number>
Overrides FakeFS.writePromise
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:77
Parameters
- fd: number
- buffer: string
- Optional position: undefined | number
Returns Promise<number>

writeSync

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

Overrides FakeFS.writeSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:88
Parameters
- fd: number
- buffer: Buffer
- Optional offset: undefined | number
- Optional length: undefined | number
- Optional position: undefined | number
Returns number
Overrides FakeFS.writeSync
- Defined in packages/yarnpkg-fslib/sources/NodeFS.ts:89
Parameters
- fd: number
- buffer: string
- Optional position: undefined | number
Returns number

Class NodeFS

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

Parameters

Default value realFs: typeof fs = fs

Returns NodeFS

Properties

pathUtils

Private realFs

Methods

accessPromise

Parameters

p: PortablePath

Optional mode: undefined | number

Returns Promise<void>

accessSync

Parameters

p: PortablePath

Optional mode: undefined | number

Returns void

appendFilePromise

Parameters

p: FSPath<PortablePath>

content: string | Uint8Array

Optional opts: WriteFileOptions

Returns Promise<void>

appendFileSync

Parameters

p: PortablePath

content: string | Uint8Array

Optional opts: WriteFileOptions

Returns void

changeFilePromise

Parameters

p: PortablePath

content: Buffer

Returns Promise<void>

Parameters

p: PortablePath

content: string

Optional opts: ChangeFileOptions

Returns Promise<void>

changeFileSync

Parameters

p: PortablePath

content: Buffer

Returns void

Parameters

p: PortablePath

content: string

Optional opts: ChangeFileOptions

Returns void

checksumFilePromise

Parameters

path: PortablePath

Default value __namedParameters: object = {}

algorithm: string

Returns Promise<string>

chmodPromise

Parameters

p: PortablePath

mask: number

Returns Promise<void>

chmodSync

Parameters

p: PortablePath

mask: number

Returns void

chownPromise

Parameters

p: PortablePath

uid: number

gid: number

Returns Promise<void>

chownSync

Parameters