Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZipFS

Hierarchy

Constructors

Methods

Constructors

constructor

  • new ZipFS(source: any, opts?: object): ZipFS

Methods

accessPromise

  • accessPromise(p: any, mode: any): Promise<void>

accessSync

  • accessSync(p: any, mode?: number): void

  • Parameters

    • p: any
    • Default value mode: number = fs.constants.F_OK

    Returns void

allocateBuffer

  • allocateBuffer(content: any): object

  • Parameters

    • content: any

    Returns object

    • buffer: any
    • byteLength: any

allocateSource

  • allocateSource(content: any): any

allocateUnattachedSource

  • allocateUnattachedSource(content: any): any

appendFilePromise

  • appendFilePromise(p: any, content: any, opts: any): Promise<void>

  • Parameters

    • p: any
    • content: any
    • opts: any

    Returns Promise<void>

appendFileSync

  • appendFileSync(p: any, content: any, opts?: object): void

  • Parameters

    • p: any
    • content: any
    • Default value opts: object = {}

    Returns void

changeFileBufferPromise

  • changeFileBufferPromise(p: any, content: any, __namedParameters?: object): Promise<void>

changeFileBufferSync

  • changeFileBufferSync(p: any, content: any, __namedParameters?: object): void

changeFilePromise

  • changeFilePromise(p: any, content: any, opts?: object): Promise<void>

changeFileSync

  • changeFileSync(p: any, content: any, opts?: object): void

changeFileTextPromise

  • changeFileTextPromise(p: any, content: any, __namedParameters?: object): Promise<void>

changeFileTextSync

  • changeFileTextSync(p: any, content: any, __namedParameters?: object): void

checksumFilePromise

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

chmodPromise

  • chmodPromise(p: any, mask: any): Promise<void>

chmodSync

  • chmodSync(p: any, mask: any): void

chownPromise

  • chownPromise(p: any, uid: any, gid: any): Promise<void>

  • Parameters

    • p: any
    • uid: any
    • gid: any

    Returns Promise<void>

chownSync

  • chownSync(p: any, uid: any, gid: any): void

closePromise

  • closePromise(fd: any): Promise<void>

closeSync

  • closeSync(fd: any): void

copyFilePromise

  • copyFilePromise(sourceP: any, destP: any, flags: any): Promise<void>

  • Parameters

    • sourceP: any
    • destP: any
    • flags: any

    Returns Promise<void>

copyFileSync

  • copyFileSync(sourceP: any, destP: any, flags?: number): void

  • Parameters

    • sourceP: any
    • destP: any
    • Default value flags: number = 0

    Returns void

copyPromise

  • copyPromise(destination: any, source: any, __namedParameters?: object): Promise<void>

  • Parameters

    • destination: any
    • source: any
    • Default value __namedParameters: object = {}
      • baseFs: this
      • linkStrategy: null
      • overwrite: boolean
      • stableSort: boolean
      • stableTime: boolean

    Returns Promise<void>

copySync

  • copySync(destination: any, source: any, __namedParameters?: object): void

  • Parameters

    • destination: any
    • source: any
    • Default value __namedParameters: object = {}
      • baseFs: this
      • overwrite: boolean

    Returns void

createReadStream

  • createReadStream(p: any, __namedParameters?: object): PassThrough & object

  • Parameters

    • p: any
    • Default value __namedParameters: object = {}
      • encoding: any

    Returns PassThrough & object

createWriteStream

  • createWriteStream(p: any, __namedParameters?: object): PassThrough & object

  • Parameters

    • p: any
    • Default value __namedParameters: object = {}
      • encoding: any

    Returns PassThrough & object

deleteEntry

  • deleteEntry(p: any, index: any): void

discardAndClose

  • discardAndClose(): void

existsPromise

  • existsPromise(p: any): Promise<boolean>

existsSync

  • existsSync(p: any): boolean

fchmodPromise

  • fchmodPromise(fd: any, mask: any): Promise<void>

fchmodSync

  • fchmodSync(fd: any, mask: any): void

fchownPromise

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

  • Parameters

    • fd: any
    • uid: any
    • gid: any

    Returns Promise<void>

fchownSync

  • fchownSync(fd: any, uid: any, gid: any): void

fdToPath

  • fdToPath(fd: any, reason: any): any

fstatPromise

fstatSync

ftruncatePromise

  • ftruncatePromise(fd: any, len: any): Promise<void>

ftruncateSync

  • ftruncateSync(fd: any, len: any): void

genTraversePromise

  • genTraversePromise(init: any, __namedParameters?: object): AsyncGenerator<any, void, unknown>

getAllFiles

  • getAllFiles(): any[]

getBufferAndClose

  • getBufferAndClose(): Buffer

getExtractHint

  • getExtractHint(hints: any): boolean

getFileSource

  • getFileSource(index: any, opts?: object): any

  • Parameters

    • index: any
    • Default value opts: object = { asyncDecompress: false }
      • asyncDecompress: boolean

    Returns any

getRealPath

  • getRealPath(): string

getUnixMode

  • getUnixMode(index: any, defaultMode: any): any

hasOpenFileHandles

  • hasOpenFileHandles(): boolean

hydrateDirectory

  • hydrateDirectory(resolvedP: any): any

isSymbolicLink

  • isSymbolicLink(index: any): boolean

linkPromise

  • linkPromise(existingP: any, newP: any): Promise<void>

  • Parameters

    • existingP: any
    • newP: any

    Returns Promise<void>

linkSync

  • linkSync(existingP: any, newP: any): void

lockPromise

  • lockPromise(affectedPath: any, callback: any): Promise<any>

lstatPromise

lstatSync

lutimesPromise

  • lutimesPromise(p: any, atime: any, mtime: any): Promise<void>

  • Parameters

    • p: any
    • atime: any
    • mtime: any

    Returns Promise<void>

lutimesSync

  • lutimesSync(p: any, atime: any, mtime: any): void

  • Parameters

    • p: any
    • atime: any
    • mtime: any

    Returns void

makeLibzipError

mkdirPromise

  • mkdirPromise(p: any, opts: any): Promise<any>

mkdirSync

  • mkdirSync(p: any, __namedParameters?: object): any

  • Parameters

    • p: any
    • Default value __namedParameters: object = {}
      • mode: number
      • recursive: boolean

    Returns any

mkdirpPromise

  • mkdirpPromise(p: any, __namedParameters?: object): Promise<any>

mkdirpSync

  • mkdirpSync(p: any, __namedParameters?: object): any

movePromise

  • movePromise(fromP: any, toP: any): Promise<void>

moveSync

  • moveSync(fromP: any, toP: any): void

openPromise

  • openPromise(p: any, flags: any, mode: any): Promise<number>

  • Parameters

    • p: any
    • flags: any
    • mode: any

    Returns Promise<number>

openSync

  • openSync(p: any, flags: any, mode: any): number

  • Parameters

    • p: any
    • flags: any
    • mode: any

    Returns number

opendirPromise

  • opendirPromise(p: any, opts: any): Promise<CustomDir>

opendirSync

  • opendirSync(p: any, opts?: object): CustomDir

prepareClose

  • prepareClose(): void

prepareCopyFile

  • prepareCopyFile(sourceP: any, destP: any, flags?: number): object

  • Parameters

    • sourceP: any
    • destP: any
    • Default value flags: number = 0

    Returns object

    • indexDest: any
    • indexSource: any
    • resolvedDestP: any

prepareReadlink

  • prepareReadlink(p: any): any

prepareWriteFile

  • prepareWriteFile(p: any, opts: any): object

  • Parameters

    • p: any
    • opts: any

    Returns object

    • encoding: any
    • index: any
    • mode: any
    • resolvedP: any

preserveTimePromise

  • preserveTimePromise(p: any, cb: any): Promise<void>

preserveTimeSync

  • preserveTimeSync(p: any, cb: any): Promise<void>

readFileBuffer

  • readFileBuffer(p: any, opts?: object): any

  • Parameters

    • p: any
    • Default value opts: object = { asyncDecompress: false }
      • asyncDecompress: boolean

    Returns any

readFilePromise

  • readFilePromise(p: any, encoding: any): Promise<any>

  • Parameters

    • p: any
    • encoding: any

    Returns Promise<any>

readFileSync

  • readFileSync(p: any, encoding: any): any

readJsonPromise

  • readJsonPromise(p: any): Promise<any>

readJsonSync

  • readJsonSync(p: any): any

readPromise

  • readPromise(fd: any, buffer: any, offset: any, length: any, position: any): Promise<number>

  • Parameters

    • fd: any
    • buffer: any
    • offset: any
    • length: any
    • position: any

    Returns Promise<number>

readSync

  • readSync(fd: any, buffer: any, offset?: number, length?: any, position?: number): number

  • Parameters

    • fd: any
    • buffer: any
    • Default value offset: number = 0
    • Default value length: any = buffer.byteLength
    • Default value position: number = -1

    Returns number

readdirPromise

  • readdirPromise(p: any, opts: any): Promise<any[]>

readdirSync

  • readdirSync(p: any, opts: any): any[]

readlinkPromise

  • readlinkPromise(p: any): Promise<any>

readlinkSync

  • readlinkSync(p: any): any

realpathPromise

  • realpathPromise(p: any): Promise<any>

realpathSync

  • realpathSync(p: any): any

registerEntry

  • registerEntry(p: any, index: any): void

registerListing

  • registerListing(p: any): any

removePromise

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

  • Parameters

    • p: any
    • Default value __namedParameters: object = {}
      • maxRetries: number
      • recursive: boolean

    Returns Promise<void>

removeSync

  • removeSync(p: any, __namedParameters?: object): void

renamePromise

  • renamePromise(oldP: any, newP: any): Promise<void>

  • Parameters

    • oldP: any
    • newP: any

    Returns Promise<void>

renameSync

  • renameSync(oldP: any, newP: any): void

resolve

  • resolve(p: any): any

resolveFilename

  • resolveFilename(reason: any, p: any, resolveLastComponent?: boolean, throwIfNoEntry?: boolean): any

  • Parameters

    • reason: any
    • p: any
    • Default value resolveLastComponent: boolean = true
    • Default value throwIfNoEntry: boolean = true

    Returns any

rmdirPromise

  • rmdirPromise(p: any, opts: any): Promise<void>

rmdirSync

  • rmdirSync(p: any, __namedParameters?: object): void

  • Parameters

    • p: any
    • Default value __namedParameters: object = {}
      • recursive: boolean

    Returns void

saveAndClose

  • saveAndClose(): void

setFileSource

  • setFileSource(p: any, content: any): any

statImpl

statPromise

statSync

symlinkPromise

  • symlinkPromise(target: any, p: any): Promise<void>

symlinkSync

  • symlinkSync(target: any, p: any): void

truncatePromise

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

  • Parameters

    • p: any
    • Default value len: number = 0

    Returns Promise<void>

truncateSync

  • truncateSync(p: any, len?: number): void

  • Parameters

    • p: any
    • Default value len: number = 0

    Returns void

unlinkPromise

  • unlinkPromise(p: any): Promise<void>

unlinkSync

  • unlinkSync(p: any): void

unregisterEntry

  • unregisterEntry(p: any): void

unregisterListing

  • unregisterListing(p: any): void

unwatchFile

  • unwatchFile(p: any, cb: any): void

utimesImpl

  • utimesImpl(resolvedP: any, mtime: any): void

utimesPromise

  • utimesPromise(p: any, atime: any, mtime: any): Promise<void>

  • Parameters

    • p: any
    • atime: any
    • mtime: any

    Returns Promise<void>

utimesSync

  • utimesSync(p: any, atime: any, mtime: any): void

  • Parameters

    • p: any
    • atime: any
    • mtime: any

    Returns void

watch

  • watch(p: any, a: any, b: any): object

watchFile

  • watchFile(p: any, a: any, b: any): any

writeFilePromise

  • writeFilePromise(p: any, content: any, opts: any): Promise<void>

  • Parameters

    • p: any
    • content: any
    • opts: any

    Returns Promise<void>

writeFileSync

  • writeFileSync(p: any, content: any, opts: any): void

  • Parameters

    • p: any
    • content: any
    • opts: any

    Returns void

writeJsonPromise

  • writeJsonPromise(p: any, data: any): Promise<any>

writeJsonSync

  • writeJsonSync(p: any, data: any): any

writePromise

  • writePromise(fd: any, buffer: any, offset: any, length: any, position: any): Promise<void>

  • Parameters

    • fd: any
    • buffer: any
    • offset: any
    • length: any
    • position: any

    Returns Promise<void>

writeSync

  • writeSync(fd: any, buffer: any, offset: any, length: any, position: any): void

  • Parameters

    • fd: any
    • buffer: any
    • offset: any
    • length: any
    • position: any

    Returns void

Generated using TypeDoc