Globals

Class ZipOpenFS

Hierarchy

BasePortableFakeFS
- ZipOpenFS

Constructors

constructor

Properties

Accessors

libzip

Methods

Constructors

constructor

new ZipOpenFS(__namedParameters: object): ZipOpenFS

Overrides BasePortableFakeFS.constructor
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:111
Parameters
- __namedParameters: object
  - baseFs: FakeFS<string & object>
  - fileExtensions: null | string[]
  - filter: null | RegExp
  - libzip: object | function
  - maxAge: number
  - maxOpenFiles: number
  - readOnlyArchives: boolean
  - useCache: boolean
Returns ZipOpenFS

Properties

Private baseFs

baseFs: FakeFS<PortablePath>

Private fdMap

fdMap: Map<number, []> = new Map()

Private fileExtensions

fileExtensions: Array<string> | null

Private filter

filter: RegExp | null

Private isZip

isZip: Set<PortablePath> = new Set()

Private libzipFactory

libzipFactory: function

Type declaration

- (): Libzip
- Returns Libzip

Private Optional libzipInstance

libzipInstance: Libzip

Private limitOpenFilesTimeout

limitOpenFilesTimeout: Timeout | null = null

Private maxAge

maxAge: number

Private maxOpenFiles

maxOpenFiles: number

Private nextFd

nextFd: number = 3

Private notZip

notZip: Set<PortablePath> = new Set()

pathUtils

pathUtils: PathUtils<PortablePath>

Private readOnlyArchives

readOnlyArchives: boolean

Private realPaths

realPaths: Map<PortablePath, PortablePath> = new Map()

Private zipInstances

zipInstances: Map<string, object> | null

Accessors

Private libzip

get libzip(): Libzip

- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:89
Returns Libzip

Methods

accessPromise

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

Overrides FakeFS.accessPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:378
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/ZipOpenFS.ts:386
Parameters
- p: PortablePath
- Optional mode: undefined | number
Returns void

appendFilePromise

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

Overrides FakeFS.appendFilePromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:671
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

Overrides FakeFS.appendFileSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:679
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>

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

chmodSync

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

Overrides FakeFS.chmodSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:511
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/ZipOpenFS.ts:543
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/ZipOpenFS.ts:551
Parameters
- p: PortablePath
- uid: number
- gid: number
Returns void

closePromise

closePromise(fd: number): Promise<void>

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

closeSync

closeSync(fd: number): void

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

copyFilePromise

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

Overrides FakeFS.copyFilePromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:599
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/ZipOpenFS.ts:635
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

Overrides FakeFS.createReadStream
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:307
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/ZipOpenFS.ts:323
Parameters
- p: PortablePath | null
- Optional opts: CreateWriteStreamOptions
Returns WriteStream

discardAndClose

discardAndClose(): void

- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:150
Returns void

existsPromise

existsPromise(p: PortablePath): Promise<boolean>

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

existsSync

existsSync(p: PortablePath): boolean

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

fchmodPromise

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

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

fchmodSync

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

Overrides FakeFS.fchmodSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:491
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/ZipOpenFS.ts:519
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/ZipOpenFS.ts:531
Parameters
- fd: number
- uid: number
- gid: number
Returns void

Private findZip

findZip(p: PortablePath): null | object

- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:990
Parameters
- p: PortablePath
Returns null | 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-fslib/sources/ZipOpenFS.ts:422
Parameters
- fd: number
Returns Promise<Stats>
Overrides FakeFS.fstatPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:423
Parameters
- fd: number
- opts: object
  - bigint: true
Returns Promise<BigIntStats>
Overrides FakeFS.fstatPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:424
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/ZipOpenFS.ts:437
Parameters
- fd: number
Returns Stats
Overrides FakeFS.fstatSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:438
Parameters
- fd: number
- opts: object
  - bigint: true
Returns BigIntStats
Overrides FakeFS.fstatSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:439
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/ZipOpenFS.ts:891
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/ZipOpenFS.ts:903
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

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

getRealPath

getRealPath(): string & object

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

Private getZipPromise

getZipPromise<T>(p: PortablePath, accept: function): Promise<T>

- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:1074
Type parameters
- T
Parameters
- p: PortablePath
- accept: function
  - - (zipFs: ZipFS): Promise<T>
    - Parameters
      - zipFs: ZipFS
      Returns Promise<T>
Returns Promise<T>

Private getZipSync

getZipSync<T>(p: PortablePath, accept: function): T

- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:1124
Type parameters
- T
Parameters
- p: PortablePath
- accept: function
  - - (zipFs: ZipFS): T
    - Parameters
      - zipFs: ZipFS
      Returns T
Returns T

Private limitOpenFiles

limitOpenFiles(max: number | null): void

- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:1040
Parameters
- max: number | null
Returns void

linkPromise

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

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

linkSync

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

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

Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:453
Parameters
- p: PortablePath
Returns Promise<Stats>
Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:454
Parameters
- p: PortablePath
- opts: StatOptions & object | undefined
Returns Promise<Stats>
Overrides FakeFS.lstatPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:455
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/ZipOpenFS.ts:465
Parameters
- p: PortablePath
Returns Stats
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:466
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats | undefined
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:467
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats | undefined
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:468
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:469
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats
Overrides FakeFS.lstatSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:470
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

Private makeCallPromise

makeCallPromise<T>(p: FSPath<PortablePath>, discard: function, accept: function, __namedParameters?: object): Promise<T>

- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:958
Type parameters
- T
Parameters
- p: FSPath<PortablePath>
- discard: function
  - - (): Promise<T>
    - Returns Promise<T>
- accept: function
  - - (zipFS: ZipFS, zipInfo: object): Promise<T>
    - Parameters
      - zipFS: ZipFS
      - zipInfo: object
        
        archivePath: PortablePath
        
        subPath: PortablePath
      Returns Promise<T>
- Default value __namedParameters: object = {}
  - requireSubpath: boolean
Returns Promise<T>

Private makeCallSync

makeCallSync<T>(p: FSPath<PortablePath>, discard: function, accept: function, __namedParameters?: object): T

- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:974
Type parameters
- T
Parameters
- p: FSPath<PortablePath>
- discard: function
  - - (): T
    - Returns T
- accept: function
  - - (zipFS: ZipFS, zipInfo: object): T
    - Parameters
      - zipFS: ZipFS
      - zipInfo: object
        
        archivePath: PortablePath
        
        subPath: PortablePath
      Returns T
- Default value __namedParameters: object = {}
  - requireSubpath: boolean
Returns T

mkdirPromise

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

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

mkdirSync

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

Overrides FakeFS.mkdirSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:743
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>

Overrides FakeFS.openPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:171
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/ZipOpenFS.ts:179
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-fslib/sources/ZipOpenFS.ts:187
Parameters
- p: PortablePath
- Optional opts: OpendirOptions
Returns Promise<object>

opendirSync

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

Overrides FakeFS.opendirSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:197
Parameters
- p: PortablePath
- Optional opts: OpendirOptions
Returns object
- path: P
- __computed: function
  - __computed(): AsyncIterableIterator<Dirent>
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:25
    Returns AsyncIterableIterator<Dirent>
- close: function
  - close(): Promise<void>
  - close(cb: NoParamCallback): void
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:27
    Returns Promise<void>
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:28
    Parameters
    - cb: NoParamCallback
    Returns void
- closeSync: function
  - closeSync(): void
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:30
    Returns void
- read: function
  - read(): Promise<Dirent | null>
  - read(cb: function): void
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:32
    Returns Promise<Dirent | null>
  - - Defined in packages/yarnpkg-fslib/sources/FakeFS.ts:33
    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:35
    Returns Dirent | null

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>

Overrides FakeFS.readFilePromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:799
Parameters
- p: FSPath<PortablePath>
- encoding: "utf8"
Returns Promise<string>
Overrides FakeFS.readFilePromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:800
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

Overrides FakeFS.readFileSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:815
Parameters
- p: FSPath<PortablePath>
- encoding: "utf8"
Returns string
Overrides FakeFS.readFileSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:816
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: number, length: number, position: number): Promise<number>

Overrides FakeFS.readPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:207
Parameters
- fd: number
- buffer: Buffer
- offset: number
- length: number
- position: number
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/ZipOpenFS.ts:219
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/ZipOpenFS.ts:831
Parameters
- p: PortablePath
Returns Promise<Array<Filename>>
Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:832
Parameters
- p: PortablePath
- opts: object | null
Returns Promise<Array<Filename>>
Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:833
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: true
Returns Promise<Array<Dirent>>
Overrides FakeFS.readdirPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:834
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/ZipOpenFS.ts:845
Parameters
- p: PortablePath
Returns Array<Filename>
Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:846
Parameters
- p: PortablePath
- opts: object | null
Returns Array<Filename>
Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:847
Parameters
- p: PortablePath
- opts: object
  - withFileTypes: true
Returns Array<Dirent>
Overrides FakeFS.readdirSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:848
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/ZipOpenFS.ts:859
Parameters
- p: PortablePath
Returns Promise<string & object>

readlinkSync

readlinkSync(p: PortablePath): string & object

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

realpathPromise

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

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

realpathSync

realpathSync(p: PortablePath): string & object

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

Private remapFd

remapFd(zipFs: ZipFS, fd: number): number

- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:165
Parameters
- zipFs: ZipFS
- fd: number
Returns number

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>

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

renameSync

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

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

resolve

resolve(p: PortablePath): string & object

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

rmdirPromise

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

Overrides FakeFS.rmdirPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:751
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/ZipOpenFS.ts:759
Parameters
- p: PortablePath
- Optional opts: RmdirOptions
Returns void

saveAndClose

saveAndClose(): void

- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:139
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>
statPromise(p: PortablePath, opts?: StatOptions): Promise<Stats | BigIntStats>

Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:395
Parameters
- p: PortablePath
Returns Promise<Stats>
Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:396
Parameters
- p: PortablePath
- opts: StatOptions & object | undefined
Returns Promise<Stats>
Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:397
Parameters
- p: PortablePath
- opts: StatOptions & object
Returns Promise<BigIntStats>
Overrides FakeFS.statPromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:398
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

Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:408
Parameters
- p: PortablePath
Returns Stats
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:409
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats | undefined
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:410
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats | undefined
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:411
Parameters
- p: PortablePath
- Optional opts: StatSyncOptions & object
Returns Stats
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:412
Parameters
- p: PortablePath
- opts: StatSyncOptions & object
Returns BigIntStats
Overrides FakeFS.statSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:413
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/ZipOpenFS.ts:783
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/ZipOpenFS.ts:791
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/ZipOpenFS.ts:875
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/ZipOpenFS.ts:883
Parameters
- p: PortablePath
- Optional len: undefined | number
Returns void

unlinkPromise

unlinkPromise(p: PortablePath): Promise<void>

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

unlinkSync

unlinkSync(p: PortablePath): void

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

unwatchFile

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

Overrides FakeFS.unwatchFile
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:950
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/ZipOpenFS.ts:719
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/ZipOpenFS.ts:727
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/ZipOpenFS.ts:915
Parameters
- p: PortablePath
- Optional cb: WatchCallback
Returns Watcher
Overrides FakeFS.watch
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:916
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/ZipOpenFS.ts:935
Parameters
- p: PortablePath
- cb: WatchFileCallback
Returns StatWatcher
Overrides FakeFS.watchFile
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:936
Parameters
- p: PortablePath
- opts: WatchFileOptions
- cb: WatchFileCallback
Returns StatWatcher

writeFilePromise

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

Overrides FakeFS.writeFilePromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:687
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

Overrides FakeFS.writeFileSync
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:695
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>

Overrides FakeFS.writePromise
- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:231
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/ZipOpenFS.ts:232
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/ZipOpenFS.ts:255
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/ZipOpenFS.ts:256
Parameters
- fd: number
- buffer: string
- Optional position: undefined | number
Returns number

Static openPromise

openPromise<T>(fn: function, opts: ZipOpenFSOptions): Promise<T>

- Defined in packages/yarnpkg-fslib/sources/ZipOpenFS.ts:76
Type parameters
- T
Parameters
- fn: function
  - - (zipOpenFs: ZipOpenFS): Promise<T>
    - Parameters
      - zipOpenFs: ZipOpenFS
      Returns Promise<T>
- opts: ZipOpenFSOptions
Returns Promise<T>

Class ZipOpenFS

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: object

baseFs: FakeFS<string & object>

fileExtensions: null | string[]

filter: null | RegExp

libzip: object | function

maxAge: number

maxOpenFiles: number

readOnlyArchives: boolean

useCache: boolean

Returns ZipOpenFS

Properties

Private baseFs

Private fdMap

Private fileExtensions

Private filter

Private isZip

Private libzipFactory

Type declaration

Returns Libzip

Private Optional libzipInstance

Private limitOpenFilesTimeout

Private maxAge

Private maxOpenFiles

Private nextFd

Private notZip

pathUtils

Private readOnlyArchives

Private realPaths

Private zipInstances

Accessors

Private libzip

Returns Libzip

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