Globals

Class DynamicFS

Hierarchy

ProxiedFS<PortablePath, PortablePath>
- DynamicFS

Constructors

constructor

Properties

Methods

Constructors

constructor

new DynamicFS(): DynamicFS

Overrides FakeFS.constructor
- Defined in packages/yarnpkg-pnp/sources/loader/_entryPoint.ts:39
Returns DynamicFS

Properties

baseFs

baseFs: FakeFS<string & object> = defaultFsLayer

pathUtils

pathUtils: PathUtils<PortablePath>

Methods

accessPromise

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

Inherited from ProxiedFS.accessPromise

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

accessSync

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

Inherited from ProxiedFS.accessSync

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

appendFilePromise

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

Inherited from ProxiedFS.appendFilePromise

Overrides FakeFS.appendFilePromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:217
Parameters
- p: FSPath<PortablePath>
- content: string | Buffer | ArrayBuffer | DataView
- Optional opts: WriteFileOptions
Returns Promise<void>

appendFileSync

appendFileSync(p: FSPath<PortablePath>, content: string | Buffer | ArrayBuffer | DataView, opts?: WriteFileOptions): void

Inherited from ProxiedFS.appendFileSync

Overrides FakeFS.appendFileSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:221
Parameters
- p: FSPath<PortablePath>
- content: string | Buffer | ArrayBuffer | DataView
- 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:488
Parameters
- p: PortablePath
- content: Buffer
Returns Promise<void>
Inherited from FakeFS.changeFilePromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:489
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:530
Parameters
- p: PortablePath
- content: Buffer
Returns void
Inherited from FakeFS.changeFileSync
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:531
Parameters
- p: PortablePath
- content: string
- Optional opts: ChangeFileOptions
Returns void

chmodPromise

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

Inherited from ProxiedFS.chmodPromise

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

chmodSync

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

Inherited from ProxiedFS.chmodSync

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

chownPromise

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

Inherited from ProxiedFS.chownPromise

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

chownSync

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

Inherited from ProxiedFS.chownSync

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

closePromise

closePromise(fd: number): Promise<void>

Inherited from ProxiedFS.closePromise

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

closeSync

closeSync(fd: number): void

Inherited from ProxiedFS.closeSync

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

copyFilePromise

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

Inherited from ProxiedFS.copyFilePromise

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

copyFileSync

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

Inherited from ProxiedFS.copyFileSync

Overrides FakeFS.copyFileSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:213
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:445
Parameters
- destination: PortablePath
- source: PortablePath
- Optional options: undefined | object
Returns Promise<void>
Inherited from FakeFS.copyPromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:446
Type parameters
- P2: Path
Parameters
- destination: PortablePath
- source: P2
- options: object
  - baseFs: FakeFS<P2>
  - Optional linkStrategy?: LinkStrategy
  - 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:452
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:453
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

Inherited from ProxiedFS.createReadStream

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

createWriteStream

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

Inherited from ProxiedFS.createWriteStream

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

existsPromise

existsPromise(p: PortablePath): Promise<boolean>

Inherited from ProxiedFS.existsPromise

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

existsSync

existsSync(p: PortablePath): boolean

Inherited from ProxiedFS.existsSync

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

fchmodPromise

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

Inherited from ProxiedFS.fchmodPromise

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

fchmodSync

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

Inherited from ProxiedFS.fchmodSync

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

fchownPromise

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

Inherited from ProxiedFS.fchownPromise

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

fchownSync

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

Inherited from ProxiedFS.fchownSync

Overrides FakeFS.fchownSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:189
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>

Inherited from ProxiedFS.fstatPromise

Overrides FakeFS.fstatPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:136
Parameters
- fd: number
Returns Promise<Stats>
Inherited from ProxiedFS.fstatPromise

Overrides FakeFS.fstatPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:137
Parameters
- fd: number
- opts: object
  - bigint: true
Returns Promise<BigIntStats>
Inherited from ProxiedFS.fstatPromise

Overrides FakeFS.fstatPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:138
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

Inherited from ProxiedFS.fstatSync

Overrides FakeFS.fstatSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:143
Parameters
- fd: number
Returns Stats
Inherited from ProxiedFS.fstatSync

Overrides FakeFS.fstatSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:144
Parameters
- fd: number
- opts: object
  - bigint: true
Returns BigIntStats
Inherited from ProxiedFS.fstatSync

Overrides FakeFS.fstatSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:145
Parameters
- fd: number
- Optional opts: undefined | object
Returns BigIntStats | Stats

ftruncatePromise

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

Inherited from ProxiedFS.ftruncatePromise

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

ftruncateSync

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

Inherited from ProxiedFS.ftruncateSync

Overrides FakeFS.ftruncateSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:355
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:281
Parameters
- init: PortablePath
- Default value __namedParameters: object = {}
  - stableSort: boolean
Returns AsyncGenerator<P, void, unknown>

getExtractHint

getExtractHint(hints: ExtractHintOptions): boolean

Inherited from ProxiedFS.getExtractHint

Overrides FakeFS.getExtractHint
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:21
Parameters
- hints: ExtractHintOptions
Returns boolean

getRealPath

getRealPath(): P

Inherited from ProxiedFS.getRealPath

Overrides FakeFS.getRealPath
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:29
Returns P

linkPromise

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

Inherited from ProxiedFS.linkPromise

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

linkSync

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

Inherited from ProxiedFS.linkSync

Overrides FakeFS.linkSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:269
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:598
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>

Inherited from ProxiedFS.lstatPromise

Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:151
Parameters
- p: PortablePath
Returns Promise<Stats>
Inherited from ProxiedFS.lstatPromise

Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:152
Parameters
- p: PortablePath
- opts: StatOptions & object | undefined
Returns Promise<Stats>
Inherited from ProxiedFS.lstatPromise

Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:153
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

Inherited from ProxiedFS.lstatSync

Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:159
Parameters
- p: PortablePath
Returns Stats
Inherited from ProxiedFS.lstatSync

Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:160
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats | undefined
Inherited from ProxiedFS.lstatSync

Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:161
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats | undefined
Inherited from ProxiedFS.lstatSync

Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:162
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats
Inherited from ProxiedFS.lstatSync

Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:163
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats
Inherited from ProxiedFS.lstatSync

Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:164
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns Stats | BigIntStats

Optional lutimesPromise

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

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

Optional lutimesSync

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

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

Protected mapFromBase

mapFromBase(p: PortablePath): PortablePath

Overrides ProxiedFS.mapFromBase
- Defined in packages/yarnpkg-pnp/sources/loader/_entryPoint.ts:49
Parameters
- p: PortablePath
Returns PortablePath

Protected mapToBase

mapToBase(p: PortablePath): PortablePath

Overrides ProxiedFS.mapToBase
- Defined in packages/yarnpkg-pnp/sources/loader/_entryPoint.ts:45
Parameters
- p: PortablePath
Returns PortablePath

mkdirPromise

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

Inherited from ProxiedFS.mkdirPromise

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

mkdirSync

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

Inherited from ProxiedFS.mkdirSync

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

mkdirpPromise

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

Inherited from FakeFS.mkdirpPromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:365
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:405
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:572
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:585
Parameters
- fromP: PortablePath
- toP: PortablePath
Returns void

openPromise

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

Inherited from ProxiedFS.openPromise

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

openSync

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

Inherited from ProxiedFS.openSync

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

opendirPromise

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

Inherited from ProxiedFS.opendirPromise

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

opendirSync

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

Inherited from ProxiedFS.opendirSync

Overrides FakeFS.opendirSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:45
Parameters
- p: PortablePath
- Optional opts: OpendirOptions
Returns Dir<PortablePath>

preserveTimePromise

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

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

readFilePromise

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

Inherited from ProxiedFS.readFilePromise

Overrides FakeFS.readFilePromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:297
Parameters
- p: FSPath<PortablePath>
- encoding: "utf8"
Returns Promise<string>
Inherited from ProxiedFS.readFilePromise

Overrides FakeFS.readFilePromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:298
Parameters
- p: FSPath<PortablePath>
- Optional encoding: undefined | string
Returns Promise<Buffer>

readFileSync

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

Inherited from ProxiedFS.readFileSync

Overrides FakeFS.readFileSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:308
Parameters
- p: FSPath<PortablePath>
- encoding: "utf8"
Returns string
Inherited from ProxiedFS.readFileSync

Overrides FakeFS.readFileSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:309
Parameters
- p: FSPath<PortablePath>
- Optional encoding: undefined | string
Returns Buffer

readJsonPromise

readJsonPromise(p: PortablePath): Promise<any>

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

readJsonSync

readJsonSync(p: PortablePath): any

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

readPromise

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

Inherited from ProxiedFS.readPromise

Overrides FakeFS.readPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:49
Parameters
- fd: number
- buffer: Buffer
- Optional offset: undefined | number
- Optional length: undefined | number
- Optional position: number | null
Returns Promise<number>

readSync

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

Inherited from ProxiedFS.readSync

Overrides FakeFS.readSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:53
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>>

Inherited from ProxiedFS.readdirPromise

Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:319
Parameters
- p: PortablePath
Returns Promise<Array<Filename>>
Inherited from ProxiedFS.readdirPromise

Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:320
Parameters
- p: PortablePath
- opts: object | null
Returns Promise<Array<Filename>>
Inherited from ProxiedFS.readdirPromise

Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:321
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: true
Returns Promise<Array<Dirent>>
Inherited from ProxiedFS.readdirPromise

Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:322
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>

Inherited from ProxiedFS.readdirSync

Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:327
Parameters
- p: PortablePath
Returns Array<Filename>
Inherited from ProxiedFS.readdirSync

Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:328
Parameters
- p: PortablePath
- opts: object | null
Returns Array<Filename>
Inherited from ProxiedFS.readdirSync

Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:329
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: true
Returns Array<Dirent>
Inherited from ProxiedFS.readdirSync

Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:330
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: boolean
Returns Array<Filename> | Array<Dirent>

readlinkPromise

readlinkPromise(p: PortablePath): Promise<P>

Inherited from ProxiedFS.readlinkPromise

Overrides FakeFS.readlinkPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:335
Parameters
- p: PortablePath
Returns Promise<P>

readlinkSync

readlinkSync(p: PortablePath): P

Inherited from ProxiedFS.readlinkSync

Overrides FakeFS.readlinkSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:339
Parameters
- p: PortablePath
Returns P

realpathPromise

realpathPromise(p: PortablePath): Promise<P>

Inherited from ProxiedFS.realpathPromise

Overrides FakeFS.realpathPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:93
Parameters
- p: PortablePath
Returns Promise<P>

realpathSync

realpathSync(p: PortablePath): P

Inherited from ProxiedFS.realpathSync

Overrides FakeFS.realpathSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:97
Parameters
- p: PortablePath
Returns P

removePromise

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

Inherited from FakeFS.removePromise
- Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:303
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:342
Parameters
- p: PortablePath
- Default value __namedParameters: object = {}
  - recursive: boolean
Returns void

renamePromise

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

Inherited from ProxiedFS.renamePromise

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

renameSync

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

Inherited from ProxiedFS.renameSync

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

resolve

resolve(path: PortablePath): P

Inherited from ProxiedFS.resolve

Overrides FakeFS.resolve
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:25
Parameters
- path: PortablePath
Returns P

rmdirPromise

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

Inherited from ProxiedFS.rmdirPromise

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

rmdirSync

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

Inherited from ProxiedFS.rmdirSync

Overrides FakeFS.rmdirSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:261
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>

Inherited from ProxiedFS.statPromise

Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:118
Parameters
- p: PortablePath
Returns Promise<Stats>
Inherited from ProxiedFS.statPromise

Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:119
Parameters
- p: PortablePath
- opts: StatOptions & object | undefined
Returns Promise<Stats>
Inherited from ProxiedFS.statPromise

Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:120
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

Inherited from ProxiedFS.statSync

Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:126
Parameters
- p: PortablePath
Returns Stats
Inherited from ProxiedFS.statSync

Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:127
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats | undefined
Inherited from ProxiedFS.statSync

Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:128
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats | undefined
Inherited from ProxiedFS.statSync

Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:129
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats
Inherited from ProxiedFS.statSync

Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:130
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats
Inherited from ProxiedFS.statSync

Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:131
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns Stats | BigIntStats

symlinkPromise

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

Inherited from ProxiedFS.symlinkPromise

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

symlinkSync

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

Inherited from ProxiedFS.symlinkSync

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

truncatePromise

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

Inherited from ProxiedFS.truncatePromise

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

truncateSync

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

Inherited from ProxiedFS.truncateSync

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

unlinkPromise

unlinkPromise(p: PortablePath): Promise<void>

Inherited from ProxiedFS.unlinkPromise

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

unlinkSync

unlinkSync(p: PortablePath): void

Inherited from ProxiedFS.unlinkSync

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

unwatchFile

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

Inherited from ProxiedFS.unwatchFile

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

utimesPromise

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

Inherited from ProxiedFS.utimesPromise

Overrides FakeFS.utimesPromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:241
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

Inherited from ProxiedFS.utimesSync

Overrides FakeFS.utimesSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:245
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

Inherited from ProxiedFS.watch

Overrides FakeFS.watch
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:359
Parameters
- p: PortablePath
- Optional cb: WatchCallback
Returns Watcher
Inherited from ProxiedFS.watch

Overrides FakeFS.watch
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:360
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

Inherited from ProxiedFS.watchFile

Overrides FakeFS.watchFile
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:370
Parameters
- p: PortablePath
- cb: WatchFileCallback
Returns StatWatcher
Inherited from ProxiedFS.watchFile

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

writeFilePromise

writeFilePromise(p: FSPath<PortablePath>, content: string | Buffer | ArrayBuffer | DataView, opts?: WriteFileOptions): Promise<void>

Inherited from ProxiedFS.writeFilePromise

Overrides FakeFS.writeFilePromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:225
Parameters
- p: FSPath<PortablePath>
- content: string | Buffer | ArrayBuffer | DataView
- Optional opts: WriteFileOptions
Returns Promise<void>

writeFileSync

writeFileSync(p: FSPath<PortablePath>, content: string | Buffer | ArrayBuffer | DataView, opts?: WriteFileOptions): void

Inherited from ProxiedFS.writeFileSync

Overrides FakeFS.writeFileSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:229
Parameters
- p: FSPath<PortablePath>
- content: string | Buffer | ArrayBuffer | DataView
- 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:695
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:699
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>

Inherited from ProxiedFS.writePromise

Overrides FakeFS.writePromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:57
Parameters
- fd: number
- buffer: Buffer
- Optional offset: undefined | number
- Optional length: undefined | number
- Optional position: undefined | number
Returns Promise<number>
Inherited from ProxiedFS.writePromise

Overrides FakeFS.writePromise
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:58
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

Inherited from ProxiedFS.writeSync

Overrides FakeFS.writeSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:67
Parameters
- fd: number
- buffer: Buffer
- Optional offset: undefined | number
- Optional length: undefined | number
- Optional position: undefined | number
Returns number
Inherited from ProxiedFS.writeSync

Overrides FakeFS.writeSync
- Defined in packages/yarnpkg-fslib/sources/ProxiedFS.ts:68
Parameters
- fd: number
- buffer: string
- Optional position: undefined | number
Returns number

Class DynamicFS

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

Returns DynamicFS

Properties

baseFs

pathUtils

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 | Buffer | ArrayBuffer | DataView

Optional opts: WriteFileOptions

Returns Promise<void>

appendFileSync

Parameters

p: FSPath<PortablePath>

content: string | Buffer | ArrayBuffer | DataView

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

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

p: PortablePath

uid: number

gid: number

Returns void

closePromise

Parameters

fd: number

Returns Promise<void>