Globals

Class ZipFS

Hierarchy

BasePortableFakeFS
- ZipFS

Constructors

constructor

Properties

Methods

Constructors

constructor

new ZipFS(): ZipFS
new ZipFS(p: PortablePath, opts?: ZipPathOptions): ZipFS
new ZipFS(data: Buffer | null, opts?: ZipBufferOptions): ZipFS

Overrides BasePortableFakeFS.constructor
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:98
Create a ZipFS in memory

Returns ZipFS
Overrides BasePortableFakeFS.constructor
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:100
Create a ZipFS in memory

Parameters
- p: PortablePath
- Optional opts: ZipPathOptions
Returns ZipFS
Overrides BasePortableFakeFS.constructor
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:101
Create a ZipFS in memory

Parameters
- data: Buffer | null
  
  If null; an empty zip file will be created
- Optional opts: ZipBufferOptions
Returns ZipFS

Properties

Private baseFs

baseFs: FakeFS<PortablePath> | null

Private entries

entries: Map<PortablePath, number> = new Map()

Private fds

fds: Map<number, object> = new Map()

Private fileSources

fileSources: Map<number, Buffer> = new Map()

A cache of indices mapped to file sources. Populated by setFileSource calls. Required for supporting read after write.

Private level

level: ZipCompression

Private libzip

libzip: Libzip

Private listings

listings: Map<PortablePath, Set<Filename>> = new Map()

Private lzSource

lzSource: number

Private nextFd

nextFd: number = 0

Private path

path: PortablePath | null

pathUtils

pathUtils: PathUtils<PortablePath>

Private readOnly

readOnly: boolean = false

Private ready

ready: boolean = false

Private stats

stats: Stats

Private symlinkCount

symlinkCount: number

Private zip

zip: number

Methods

accessPromise

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

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

accessSync

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

Overrides FakeFS.accessSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:566
Parameters
- p: PortablePath
- Default value mode: number = constants.F_OK
Returns void

Private allocateBuffer

allocateBuffer(content: string | Buffer | ArrayBuffer | DataView): object

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:879
Parameters
- content: string | Buffer | ArrayBuffer | DataView
Returns object
- buffer: number
- byteLength: number

Private allocateSource

allocateSource(content: string | Buffer | ArrayBuffer | DataView): number

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:908
Parameters
- content: string | Buffer | ArrayBuffer | DataView
Returns number

Private allocateUnattachedSource

allocateUnattachedSource(content: string | Buffer | ArrayBuffer | DataView): number

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:894
Parameters
- content: string | Buffer | ArrayBuffer | DataView
Returns number

appendFilePromise

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

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

appendFileSync

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

Overrides FakeFS.appendFileSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1150
Parameters
- p: FSPath<PortablePath>
- content: string | Uint8Array
- Default value 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-libzip/sources/ZipFS.ts:1040
Parameters
- p: PortablePath
- mask: number
Returns Promise<void>

chmodSync

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

Overrides FakeFS.chmodSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1044
Parameters
- p: PortablePath
- mask: number
Returns void

chownPromise

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

Overrides FakeFS.chownPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1074
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-libzip/sources/ZipFS.ts:1078
Parameters
- p: PortablePath
- uid: number
- gid: number
Returns void

closePromise

closePromise(fd: number): Promise<void>

Overrides FakeFS.closePromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:420
Parameters
- fd: number
Returns Promise<void>

closeSync

closeSync(fd: number): void

Overrides FakeFS.closeSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:424
Parameters
- fd: number
Returns void

copyFilePromise

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

Overrides FakeFS.copyFilePromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1090
Parameters
- sourceP: PortablePath
- destP: PortablePath
- Optional flags: undefined | number
Returns Promise<void>

copyFileSync

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

Overrides FakeFS.copyFileSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1100
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, __namedParameters?: object): ReadStream

Overrides FakeFS.createReadStream
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:432
Parameters
- p: PortablePath | null
- Default value __namedParameters: object = {}
  - encoding: undefined | "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"
Returns ReadStream

createWriteStream

createWriteStream(p: PortablePath | null, __namedParameters?: object): WriteStream

Overrides FakeFS.createWriteStream
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:472
Parameters
- p: PortablePath | null
- Default value __namedParameters: object = {}
  - encoding: undefined | "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"
Returns WriteStream

Private deleteEntry

deleteEntry(p: PortablePath, index: number): void

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:814
Parameters
- p: PortablePath
- index: number
Returns void

discardAndClose

discardAndClose(): void

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:309
Returns void

existsPromise

existsPromise(p: PortablePath): Promise<boolean>

Overrides FakeFS.existsPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:535
Parameters
- p: PortablePath
Returns Promise<boolean>

existsSync

existsSync(p: PortablePath): boolean

Overrides FakeFS.existsSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:539
Parameters
- p: PortablePath
Returns boolean

fchmodPromise

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

Overrides FakeFS.fchmodPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1032
Parameters
- fd: number
- mask: number
Returns Promise<void>

fchmodSync

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

Overrides FakeFS.fchmodSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1036
Parameters
- fd: number
- mask: number
Returns void

fchownPromise

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

Overrides FakeFS.fchownPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1066
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-libzip/sources/ZipFS.ts:1070
Parameters
- fd: number
- uid: number
- gid: number
Returns void

Private fdToPath

fdToPath(fd: number, reason: string): string & object

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1164
Parameters
- fd: number
- reason: string
Returns string & object

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-libzip/sources/ZipFS.ts:615
Parameters
- fd: number
Returns Promise<Stats>
Overrides FakeFS.fstatPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:616
Parameters
- fd: number
- opts: object
  - bigint: true
Returns Promise<BigIntStats>
Overrides FakeFS.fstatPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:617
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-libzip/sources/ZipFS.ts:622
Parameters
- fd: number
Returns Stats
Overrides FakeFS.fstatSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:623
Parameters
- fd: number
- opts: object
  - bigint: true
Returns BigIntStats
Overrides FakeFS.fstatSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:624
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-libzip/sources/ZipFS.ts:1544
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-libzip/sources/ZipFS.ts:1548
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>

getAllFiles

getAllFiles(): (string & object)[]

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:231
Returns (string & object)[]

getBufferAndClose

getBufferAndClose(): Buffer

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:249
Returns Buffer

getExtractHint

getExtractHint(hints: ExtractHintOptions): boolean

Overrides FakeFS.getExtractHint
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:220
Parameters
- hints: ExtractHintOptions
Returns boolean

Private getFileSource

getFileSource(index: number): Buffer
getFileSource(index: number, opts: object): Buffer
getFileSource(index: number, opts: object): Promise<Buffer>
getFileSource(index: number, opts: object): Promise<Buffer> | Buffer

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:968
Parameters
- index: number
Returns Buffer
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:969
Parameters
- index: number
- opts: object
  - asyncDecompress: false
Returns Buffer
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:970
Parameters
- index: number
- opts: object
  - asyncDecompress: true
Returns Promise<Buffer>
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:971
Parameters
- index: number
- opts: object
  - asyncDecompress: boolean
Returns Promise<Buffer> | Buffer

getRealPath

getRealPath(): string & object

Overrides FakeFS.getRealPath
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:235
Returns string & object

Private getUnixMode

getUnixMode(index: number, defaultMode: number): number

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:758
Parameters
- index: number
- defaultMode: number
Returns number

hasOpenFileHandles

hasOpenFileHandles(): boolean

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:349
Returns boolean

Private hydrateDirectory

hydrateDirectory(resolvedP: PortablePath): number

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1352
Parameters
- resolvedP: PortablePath
Returns number

Private isSymbolicLink

isSymbolicLink(index: number): boolean

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:952
Parameters
- index: number
Returns boolean

linkPromise

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

Overrides FakeFS.linkPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1363
Parameters
- existingP: PortablePath
- newP: PortablePath
Returns Promise<void>

linkSync

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

Overrides FakeFS.linkSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1367
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>
lstatPromise(p: PortablePath, opts?: StatOptions): Promise<Stats | BigIntStats>

Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:644
Parameters
- p: PortablePath
Returns Promise<Stats>
Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:645
Parameters
- p: PortablePath
- opts: StatOptions & object | undefined
Returns Promise<Stats>
Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:646
Parameters
- p: PortablePath
- opts: StatOptions & object
Returns Promise<BigIntStats>
Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:647
Parameters
- p: PortablePath
- Optional opts: StatOptions
Returns Promise<Stats | 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
lstatSync(p: PortablePath, opts?: StatSyncOptions): Stats | BigIntStats | undefined

Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:656
Parameters
- p: PortablePath
Returns Stats
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:657
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats | undefined
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:658
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats | undefined
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:659
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:660
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:661
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns Stats | BigIntStats
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:662
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions
Returns Stats | BigIntStats | undefined

lutimesPromise

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

Overrides FakeFS.lutimesPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1274
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-libzip/sources/ZipFS.ts:1278
Parameters
- p: PortablePath
- atime: Date | string | number
- mtime: Date | string | number
Returns void

makeLibzipError

makeLibzipError(error: number): LibzipError

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:207
Parameters
- error: number
Returns LibzipError

mkdirPromise

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

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

mkdirSync

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

Overrides FakeFS.mkdirSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1306
Parameters
- p: PortablePath
- Default value __namedParameters: object = {}
  - mode: number
  - recursive: boolean
Returns undefined | string

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-libzip/sources/ZipFS.ts:339
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-libzip/sources/ZipFS.ts:343
Parameters
- p: PortablePath
- flags: string
- Optional mode: undefined | number
Returns number

opendirPromise

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

Overrides FakeFS.opendirPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:353
Parameters
- p: PortablePath
- Optional opts: OpendirOptions
Returns Promise<object>

opendirSync

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

Overrides FakeFS.opendirSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:357
Parameters
- p: PortablePath
- Default value opts: OpendirOptions = {}
Returns Dir<PortablePath>

Private prepareClose

prepareClose(): void

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:242
Returns void

Private prepareCopyFile

prepareCopyFile(sourceP: PortablePath, destP: PortablePath, flags?: number): object

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1110
Parameters
- sourceP: PortablePath
- destP: PortablePath
- Default value flags: number = 0
Returns object
- indexDest: undefined | number
- indexSource: number
- resolvedDestP: string & object

Private prepareReadlink

prepareReadlink(p: PortablePath): number

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1492
Parameters
- p: PortablePath
Returns number

Private prepareWriteFile

prepareWriteFile(p: FSPath<PortablePath>, opts?: WriteFileOptions): object

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1210
Parameters
- p: FSPath<PortablePath>
- Optional opts: WriteFileOptions
Returns object
- encoding: null | "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"
- index: undefined | number
- mode: null | number
- resolvedP: string & object

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>

Private readFileBuffer

readFileBuffer(p: FSPath<PortablePath>): Buffer
readFileBuffer(p: FSPath<PortablePath>, opts: object): Buffer
readFileBuffer(p: FSPath<PortablePath>, opts: object): Promise<Buffer>
readFileBuffer(p: FSPath<PortablePath>, opts: object): Promise<Buffer> | Buffer

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1424
Parameters
- p: FSPath<PortablePath>
Returns Buffer
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1425
Parameters
- p: FSPath<PortablePath>
- opts: object
  - asyncDecompress: false
Returns Buffer
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1426
Parameters
- p: FSPath<PortablePath>
- opts: object
  - asyncDecompress: true
Returns Promise<Buffer>
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1427
Parameters
- p: FSPath<PortablePath>
- opts: object
  - asyncDecompress: boolean
Returns Promise<Buffer> | Buffer

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-libzip/sources/ZipFS.ts:1398
Parameters
- p: FSPath<PortablePath>
- Optional encoding: undefined | null
Returns Promise<Buffer>
Overrides FakeFS.readFilePromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1399
Parameters
- p: FSPath<PortablePath>
- encoding: BufferEncoding
Returns Promise<string>
Overrides FakeFS.readFilePromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1400
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-libzip/sources/ZipFS.ts:1411
Parameters
- p: FSPath<PortablePath>
- Optional encoding: undefined | null
Returns Buffer
Overrides FakeFS.readFileSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1412
Parameters
- p: FSPath<PortablePath>
- encoding: BufferEncoding
Returns string
Overrides FakeFS.readFileSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1413
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?: undefined | number, length?: undefined | number, position?: number | null): Promise<number>

Overrides FakeFS.readPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:377
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 | null): number

Overrides FakeFS.readSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:381
Parameters
- fd: number
- buffer: Buffer
- Default value offset: number = 0
- Default value length: number = buffer.byteLength
- Default value position: number | null = -1
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<DirEntry>>
readdirPromise(p: PortablePath, opts: object): Promise<Array<Filename> | Array<DirEntry>>

Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1450
Parameters
- p: PortablePath
Returns Promise<Array<Filename>>
Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1451
Parameters
- p: PortablePath
- opts: object | null
Returns Promise<Array<Filename>>
Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1452
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: true
Returns Promise<Array<DirEntry>>
Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1453
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: boolean
Returns Promise<Array<Filename> | Array<DirEntry>>

readdirSync

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

Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1458
Parameters
- p: PortablePath
Returns Array<Filename>
Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1459
Parameters
- p: PortablePath
- opts: object | null
Returns Array<Filename>
Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1460
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: true
Returns Array<DirEntry>
Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1461
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: boolean
Returns Array<Filename> | Array<DirEntry>

readlinkPromise

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

Overrides FakeFS.readlinkPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1482
Parameters
- p: PortablePath
Returns Promise<string & object>

readlinkSync

readlinkSync(p: PortablePath): PortablePath

Overrides FakeFS.readlinkSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1487
Parameters
- p: PortablePath
Returns PortablePath

realpathPromise

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

Overrides FakeFS.realpathPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:522
Parameters
- p: PortablePath
Returns Promise<string & object>

realpathSync

realpathSync(p: PortablePath): PortablePath

Overrides FakeFS.realpathSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:526
Parameters
- p: PortablePath
Returns PortablePath

Private registerEntry

registerEntry(p: PortablePath, index: number): void

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:784
Parameters
- p: PortablePath
- index: number
Returns void

Private registerListing

registerListing(p: PortablePath): Set<string & object>

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:770
Parameters
- p: PortablePath
Returns Set<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<never>

Overrides FakeFS.renamePromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1082
Parameters
- oldP: PortablePath
- newP: PortablePath
Returns Promise<never>

renameSync

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

Overrides FakeFS.renameSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1086
Parameters
- oldP: PortablePath
- newP: PortablePath
Returns never

resolve

resolve(p: PortablePath): string & object

Overrides FakeFS.resolve
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:335
Parameters
- p: PortablePath
Returns string & object

Private resolveFilename

resolveFilename(reason: string, p: PortablePath, resolveLastComponent?: undefined | false | true): PortablePath
resolveFilename(reason: string, p: PortablePath, resolveLastComponent: boolean | undefined, throwIfNoEntry: boolean | undefined): PortablePath | undefined

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:823
Parameters
- reason: string
- p: PortablePath
- Optional resolveLastComponent: undefined | false | true
Returns PortablePath
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:824
Parameters
- reason: string
- p: PortablePath
- resolveLastComponent: boolean | undefined
- throwIfNoEntry: boolean | undefined
Returns PortablePath | undefined

rmdirPromise

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

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

rmdirSync

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

Overrides FakeFS.rmdirSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1327
Parameters
- p: PortablePath
- Default value __namedParameters: object = {}
  - recursive: boolean
Returns void

saveAndClose

saveAndClose(): void

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:317
Returns void

Private setFileSource

setFileSource(p: PortablePath, content: string | Buffer | ArrayBuffer | DataView): number

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:920
Parameters
- p: PortablePath
- content: string | Buffer | ArrayBuffer | DataView
Returns number

Private statImpl

statImpl(reason: string, p: PortablePath, opts: object): BigIntStats
statImpl(reason: string, p: PortablePath, opts?: undefined | object): Stats
statImpl(reason: string, p: PortablePath, opts?: undefined | object): Stats | BigIntStats

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:681
Parameters
- reason: string
- p: PortablePath
- opts: object
  - bigint: true
Returns BigIntStats
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:682
Parameters
- reason: string
- p: PortablePath
- Optional opts: undefined | object
Returns Stats
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:683
Parameters
- reason: string
- p: PortablePath
- Optional opts: undefined | object
Returns Stats | BigIntStats

statPromise

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

Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:578
Parameters
- p: PortablePath
Returns Promise<Stats>
Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:579
Parameters
- p: PortablePath
- opts: StatOptions & object | undefined
Returns Promise<Stats>
Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:580
Parameters
- p: PortablePath
- opts: StatOptions & object
Returns Promise<BigIntStats>
Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:581
Parameters
- p: PortablePath
- Optional opts: StatOptions
Returns Promise<Stats | 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
statSync(p: PortablePath, opts?: StatSyncOptions): Stats | BigIntStats | undefined

Overrides FakeFS.statSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:590
Parameters
- p: PortablePath
Returns Stats
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:591
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats | undefined
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:592
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats | undefined
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:593
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:594
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:595
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns Stats | BigIntStats
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:596
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions
Returns Stats | BigIntStats | undefined

symlinkPromise

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

Overrides FakeFS.symlinkPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1373
Parameters
- target: PortablePath
- p: PortablePath
Returns Promise<void>

symlinkSync

symlinkSync(target: PortablePath, p: PortablePath): void

Overrides FakeFS.symlinkSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1377
Parameters
- target: PortablePath
- p: PortablePath
Returns void

truncatePromise

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

Overrides FakeFS.truncatePromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1514
Parameters
- p: PortablePath
- Default value len: number = 0
Returns Promise<void>

truncateSync

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

Overrides FakeFS.truncateSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1529
Parameters
- p: PortablePath
- Default value len: number = 0
Returns void

unlinkPromise

unlinkPromise(p: PortablePath): Promise<void>

Overrides FakeFS.unlinkPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1242
Parameters
- p: PortablePath
Returns Promise<void>

unlinkSync

unlinkSync(p: PortablePath): void

Overrides FakeFS.unlinkSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1246
Parameters
- p: PortablePath
Returns void

Private unregisterEntry

unregisterEntry(p: PortablePath): void

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:798
Parameters
- p: PortablePath
Returns void

Private unregisterListing

unregisterListing(p: PortablePath): void

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:791
Parameters
- p: PortablePath
Returns void

unwatchFile

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

Overrides FakeFS.unwatchFile
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1586
Parameters
- p: PortablePath
- Optional cb: WatchFileCallback
Returns void

Private utimesImpl

utimesImpl(resolvedP: PortablePath, mtime: Date | string | number): void

- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1287
Parameters
- resolvedP: PortablePath
- mtime: Date | string | number
Returns void

utimesPromise

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

Overrides FakeFS.utimesPromise
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1261
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-libzip/sources/ZipFS.ts:1265
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-libzip/sources/ZipFS.ts:1552
Parameters
- p: PortablePath
- Optional cb: WatchCallback
Returns Watcher
Overrides FakeFS.watch
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1553
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-libzip/sources/ZipFS.ts:1578
Parameters
- p: PortablePath
- cb: WatchFileCallback
Returns StatWatcher
Overrides FakeFS.watchFile
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1579
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-libzip/sources/ZipFS.ts:1172
Parameters
- p: FSPath<PortablePath>
- content: string | NodeJS.ArrayBufferView
- Optional opts: WriteFileOptions
Returns Promise<void>

writeFileSync

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

Overrides FakeFS.writeFileSync
- Defined in packages/yarnpkg-libzip/sources/ZipFS.ts:1191
Parameters
- p: FSPath<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-libzip/sources/ZipFS.ts:400
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-libzip/sources/ZipFS.ts:401
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-libzip/sources/ZipFS.ts:410
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-libzip/sources/ZipFS.ts:411
Parameters
- fd: number
- buffer: string
- Optional position: undefined | number
Returns number

Class ZipFS

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

Returns ZipFS

Parameters

p: PortablePath

Optional opts: ZipPathOptions

Returns ZipFS

Parameters

data: Buffer | null

Optional opts: ZipBufferOptions

Returns ZipFS

Properties

Private baseFs

Private entries

Private fds

Private fileSources

Private level

Private libzip

Private listings

Private lzSource

Private nextFd

Private path

pathUtils

Private readOnly

Private ready

Private stats

Private symlinkCount

Private zip

Methods

accessPromise

Parameters

p: PortablePath

Optional mode: undefined | number

Returns Promise<void>

accessSync

Parameters

p: PortablePath

Default value mode: number = constants.F_OK

Returns void

Private allocateBuffer

Parameters

content: string | Buffer | ArrayBuffer | DataView

Returns object

buffer: number

byteLength: number

Private allocateSource

Parameters

content: string | Buffer | ArrayBuffer | DataView

Returns number

Private allocateUnattachedSource

Parameters

content: string | Buffer | ArrayBuffer | DataView

Returns number

appendFilePromise

Parameters

p: FSPath<PortablePath>

content: string | Uint8Array

Optional opts: WriteFileOptions

Returns Promise<void>

appendFileSync

Parameters

p: FSPath<PortablePath>

content: string | Uint8Array

Default value opts: WriteFileOptions = {}

Returns void

changeFilePromise

Parameters

p: PortablePath

content: Buffer

Returns Promise<void>

Parameters

p: PortablePath

content: string

Optional opts: ChangeFileOptions

Returns Promise<void>