@yarnpkg/libzip
This package contains a wasm-compiled version of the libzip.
Upgrade the libzip build
- Bump the version numbers in
artifacts/build.sh
- Run the
artifacts/build.sh
script
Expose new functions
- Add the new functions to
artifacts/exported.json
- List them in
sources/index.ts
- Run the
artifacts/build.sh
script
Index
Functions
getArchivePart
Parameters
path: string
extension: string
Returns null | PortablePath
getLibzipPromise
Returns Promise<{ SEEK_CUR: 1; SEEK_END: 2; SEEK_SET: 0; ZIP_CHECKCONS: 4; ZIP_CM_DEFAULT: -1; ZIP_CM_DEFLATE: 8; ZIP_CM_STORE: 0; ZIP_EXCL: 2; ZIP_FL_COMPRESSED: 4; ZIP_FL_OVERWRITE: 8192; ZIP_OPSYS_ACORN_RISC: 13; ZIP_OPSYS_ALTERNATE_MVS: 15; ZIP_OPSYS_AMIGA: 1; ZIP_OPSYS_ATARI_ST: 5; ZIP_OPSYS_BEOS: 16; ZIP_OPSYS_CPM: 9; ZIP_OPSYS_DOS: 0; ZIP_OPSYS_MACINTOSH: 7; ZIP_OPSYS_MVS: 11; ZIP_OPSYS_OPENVMS: 2; ZIP_OPSYS_OS_2: 6; ZIP_OPSYS_OS_400: 18; ZIP_OPSYS_OS_X: 19; ZIP_OPSYS_TANDEM: 17; ZIP_OPSYS_UNIX: 3; ZIP_OPSYS_VFAT: 14; ZIP_OPSYS_VM_CMS: 4; ZIP_OPSYS_VSE: 12; ZIP_OPSYS_WINDOWS_NTFS: 10; ZIP_OPSYS_Z_SYSTEM: 8; ZIP_RDONLY: 16; close: (...arg: [number]) => number; delete: (...arg: [number, number]) => number; dir: { add: (...arg: [number, string]) => number }; discard: (...arg: [number]) => null; error: { initWithCode: (...arg: [number, number]) => null; strerror: (...arg: [number]) => string }; errors: typeof Errors; ext: { countSymlinks: (...arg: [number]) => number }; fclose: (...arg: [number]) => number; file: { add: (...arg: [number, string, number, number]) => number; getError: (...arg: [number]) => number; getExternalAttributes: (...arg: [number, number, number, number, number, number]) => number; setCompression: (...arg: [number, number, number, number, number]) => number; setExternalAttributes: (...arg: [number, number, number, number, number, number]) => number; setMtime: (...arg: [number, number, number, number, number]) => number }; fopenIndex: (...arg: [number, number, number, number]) => number; fread: (...arg: [number, number, number, number]) => number; free: (ptr: number) => void; getError: (...arg: [number]) => number; getName: (...arg: [number, number, number]) => string; getNumEntries: (...arg: [number, number]) => number; getValue: (ptr: number, type: CType, noSafe?: boolean) => number; malloc: (size: number) => number; name: { locate: (...arg: [number, string, number]) => number }; openFromSource: (...arg: [number, number, number]) => number; source: { close: (...arg: [number]) => number; error: (...arg: [number]) => number; free: (...arg: [number]) => null; fromBuffer: (...arg: [number, number, number, number, number]) => number; fromUnattachedBuffer: (...arg: [number, number, number, number, number]) => number; keep: (...arg: [number]) => null; open: (...arg: [number]) => number; read: (...arg: [number, number, number]) => number; seek: (...arg: [number, number, number, number]) => number; tell: (...arg: [number]) => number }; statIndex: (...arg: [number, number, number, number, number]) => number; struct: { errorCodeZip: (...arg: [number]) => number; errorS: (...arg: []) => number; statCompMethod: (...arg: [number]) => number; statCompSize: (...arg: [number]) => number; statCrc: (...arg: [number]) => number; statMtime: (...arg: [number]) => number; statS: (...arg: []) => number; statSize: (...arg: [number]) => number }; uint08S: number; uint32S: number; HEAPU8: any }>
getLibzipSync
Returns { SEEK_CUR: 1; SEEK_END: 2; SEEK_SET: 0; ZIP_CHECKCONS: 4; ZIP_CM_DEFAULT: -1; ZIP_CM_DEFLATE: 8; ZIP_CM_STORE: 0; ZIP_EXCL: 2; ZIP_FL_COMPRESSED: 4; ZIP_FL_OVERWRITE: 8192; ZIP_OPSYS_ACORN_RISC: 13; ZIP_OPSYS_ALTERNATE_MVS: 15; ZIP_OPSYS_AMIGA: 1; ZIP_OPSYS_ATARI_ST: 5; ZIP_OPSYS_BEOS: 16; ZIP_OPSYS_CPM: 9; ZIP_OPSYS_DOS: 0; ZIP_OPSYS_MACINTOSH: 7; ZIP_OPSYS_MVS: 11; ZIP_OPSYS_OPENVMS: 2; ZIP_OPSYS_OS_2: 6; ZIP_OPSYS_OS_400: 18; ZIP_OPSYS_OS_X: 19; ZIP_OPSYS_TANDEM: 17; ZIP_OPSYS_UNIX: 3; ZIP_OPSYS_VFAT: 14; ZIP_OPSYS_VM_CMS: 4; ZIP_OPSYS_VSE: 12; ZIP_OPSYS_WINDOWS_NTFS: 10; ZIP_OPSYS_Z_SYSTEM: 8; ZIP_RDONLY: 16; close: (...arg: [number]) => number; delete: (...arg: [number, number]) => number; dir: { add: (...arg: [number, string]) => number }; discard: (...arg: [number]) => null; error: { initWithCode: (...arg: [number, number]) => null; strerror: (...arg: [number]) => string }; errors: typeof Errors; ext: { countSymlinks: (...arg: [number]) => number }; fclose: (...arg: [number]) => number; file: { add: (...arg: [number, string, number, number]) => number; getError: (...arg: [number]) => number; getExternalAttributes: (...arg: [number, number, number, number, number, number]) => number; setCompression: (...arg: [number, number, number, number, number]) => number; setExternalAttributes: (...arg: [number, number, number, number, number, number]) => number; setMtime: (...arg: [number, number, number, number, number]) => number }; fopenIndex: (...arg: [number, number, number, number]) => number; fread: (...arg: [number, number, number, number]) => number; free: (ptr: number) => void; getError: (...arg: [number]) => number; getName: (...arg: [number, number, number]) => string; getNumEntries: (...arg: [number, number]) => number; getValue: (ptr: number, type: CType, noSafe?: boolean) => number; malloc: (size: number) => number; name: { locate: (...arg: [number, string, number]) => number }; openFromSource: (...arg: [number, number, number]) => number; source: { close: (...arg: [number]) => number; error: (...arg: [number]) => number; free: (...arg: [number]) => null; fromBuffer: (...arg: [number, number, number, number, number]) => number; fromUnattachedBuffer: (...arg: [number, number, number, number, number]) => number; keep: (...arg: [number]) => null; open: (...arg: [number]) => number; read: (...arg: [number, number, number]) => number; seek: (...arg: [number, number, number, number]) => number; tell: (...arg: [number]) => number }; statIndex: (...arg: [number, number, number, number, number]) => number; struct: { errorCodeZip: (...arg: [number]) => number; errorS: (...arg: []) => number; statCompMethod: (...arg: [number]) => number; statCompSize: (...arg: [number]) => number; statCrc: (...arg: [number]) => number; statMtime: (...arg: [number]) => number; statS: (...arg: []) => number; statSize: (...arg: [number]) => number }; uint08S: number; uint32S: number; HEAPU8: any }
readonlySEEK_CUR: 1
readonlySEEK_END: 2
readonlySEEK_SET: 0
readonlyZIP_CHECKCONS: 4
readonlyZIP_CM_DEFAULT: -1
readonlyZIP_CM_DEFLATE: 8
readonlyZIP_CM_STORE: 0
readonlyZIP_EXCL: 2
readonlyZIP_FL_COMPRESSED: 4
readonlyZIP_FL_OVERWRITE: 8192
readonlyZIP_OPSYS_ACORN_RISC: 13
readonlyZIP_OPSYS_ALTERNATE_MVS: 15
readonlyZIP_OPSYS_AMIGA: 1
readonlyZIP_OPSYS_ATARI_ST: 5
readonlyZIP_OPSYS_BEOS: 16
readonlyZIP_OPSYS_CPM: 9
readonlyZIP_OPSYS_DOS: 0
readonlyZIP_OPSYS_MACINTOSH: 7
readonlyZIP_OPSYS_MVS: 11
readonlyZIP_OPSYS_OPENVMS: 2
readonlyZIP_OPSYS_OS_2: 6
readonlyZIP_OPSYS_OS_400: 18
readonlyZIP_OPSYS_OS_X: 19
readonlyZIP_OPSYS_TANDEM: 17
readonlyZIP_OPSYS_UNIX: 3
readonlyZIP_OPSYS_VFAT: 14
readonlyZIP_OPSYS_VM_CMS: 4
readonlyZIP_OPSYS_VSE: 12
readonlyZIP_OPSYS_WINDOWS_NTFS: 10
readonlyZIP_OPSYS_Z_SYSTEM: 8
readonlyZIP_RDONLY: 16
readonlyclose: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlydelete: (...arg: [number, number]) => number
Parameters
rest...arg: [number, number]
Returns number
readonlydir: { add: (...arg: [number, string]) => number }
readonlyadd: (...arg: [number, string]) => number
Parameters
rest...arg: [number, string]
Returns number
readonlydiscard: (...arg: [number]) => null
Parameters
rest...arg: [number]
Returns null
readonlyerror: { initWithCode: (...arg: [number, number]) => null; strerror: (...arg: [number]) => string }
readonlyinitWithCode: (...arg: [number, number]) => null
Parameters
rest...arg: [number, number]
Returns null
readonlystrerror: (...arg: [number]) => string
Parameters
rest...arg: [number]
Returns string
readonlyerrors: typeof Errors
readonlyext: { countSymlinks: (...arg: [number]) => number }
readonlycountSymlinks: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlyfclose: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlyfile: { add: (...arg: [number, string, number, number]) => number; getError: (...arg: [number]) => number; getExternalAttributes: (...arg: [number, number, number, number, number, number]) => number; setCompression: (...arg: [number, number, number, number, number]) => number; setExternalAttributes: (...arg: [number, number, number, number, number, number]) => number; setMtime: (...arg: [number, number, number, number, number]) => number }
readonlyadd: (...arg: [number, string, number, number]) => number
Parameters
rest...arg: [number, string, number, number]
Returns number
readonlygetError: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlygetExternalAttributes: (...arg: [number, number, number, number, number, number]) => number
Parameters
rest...arg: [number, number, number, number, number, number]
Returns number
readonlysetCompression: (...arg: [number, number, number, number, number]) => number
Parameters
rest...arg: [number, number, number, number, number]
Returns number
readonlysetExternalAttributes: (...arg: [number, number, number, number, number, number]) => number
Parameters
rest...arg: [number, number, number, number, number, number]
Returns number
readonlysetMtime: (...arg: [number, number, number, number, number]) => number
Parameters
rest...arg: [number, number, number, number, number]
Returns number
readonlyfopenIndex: (...arg: [number, number, number, number]) => number
Parameters
rest...arg: [number, number, number, number]
Returns number
readonlyfread: (...arg: [number, number, number, number]) => number
Parameters
rest...arg: [number, number, number, number]
Returns number
readonlyfree: (ptr: number) => void
Parameters
ptr: number
Returns void
readonlygetError: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlygetName: (...arg: [number, number, number]) => string
Parameters
rest...arg: [number, number, number]
Returns string
readonlygetNumEntries: (...arg: [number, number]) => number
Parameters
rest...arg: [number, number]
Returns number
readonlygetValue: (ptr: number, type: CType, noSafe?: boolean) => number
Parameters
ptr: number
type: CType
optionalnoSafe: boolean
Returns number
readonlymalloc: (size: number) => number
Parameters
size: number
Returns number
readonlyname: { locate: (...arg: [number, string, number]) => number }
readonlylocate: (...arg: [number, string, number]) => number
Parameters
rest...arg: [number, string, number]
Returns number
readonlyopenFromSource: (...arg: [number, number, number]) => number
Parameters
rest...arg: [number, number, number]
Returns number
readonlysource: { close: (...arg: [number]) => number; error: (...arg: [number]) => number; free: (...arg: [number]) => null; fromBuffer: (...arg: [number, number, number, number, number]) => number; fromUnattachedBuffer: (...arg: [number, number, number, number, number]) => number; keep: (...arg: [number]) => null; open: (...arg: [number]) => number; read: (...arg: [number, number, number]) => number; seek: (...arg: [number, number, number, number]) => number; tell: (...arg: [number]) => number }
readonlyclose: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlyerror: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlyfree: (...arg: [number]) => null
Parameters
rest...arg: [number]
Returns null
readonlyfromBuffer: (...arg: [number, number, number, number, number]) => number
Parameters
rest...arg: [number, number, number, number, number]
Returns number
readonlyfromUnattachedBuffer: (...arg: [number, number, number, number, number]) => number
Parameters
rest...arg: [number, number, number, number, number]
Returns number
readonlykeep: (...arg: [number]) => null
Parameters
rest...arg: [number]
Returns null
readonlyopen: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlyread: (...arg: [number, number, number]) => number
Parameters
rest...arg: [number, number, number]
Returns number
readonlyseek: (...arg: [number, number, number, number]) => number
Parameters
rest...arg: [number, number, number, number]
Returns number
readonlytell: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlystatIndex: (...arg: [number, number, number, number, number]) => number
Parameters
rest...arg: [number, number, number, number, number]
Returns number
readonlystruct: { errorCodeZip: (...arg: [number]) => number; errorS: (...arg: []) => number; statCompMethod: (...arg: [number]) => number; statCompSize: (...arg: [number]) => number; statCrc: (...arg: [number]) => number; statMtime: (...arg: [number]) => number; statS: (...arg: []) => number; statSize: (...arg: [number]) => number }
readonlyerrorCodeZip: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlyerrorS: (...arg: []) => number
Parameters
rest...arg: []
Returns number
readonlystatCompMethod: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlystatCompSize: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlystatCrc: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlystatMtime: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlystatS: (...arg: []) => number
Parameters
rest...arg: []
Returns number
readonlystatSize: (...arg: [number]) => number
Parameters
rest...arg: [number]
Returns number
readonlyuint08S: number
readonlyuint32S: number
get HEAPU8(): Uint8Array
makeEmptyArchive
Returns Buffer
mountMemoryDrive
Parameters
origFs: __module
mountPoint: PortablePath
source: null | Buffer = ...
optionalopts: MemoryDriveOpts
Returns ZipFS
Type Aliases
Libzip
ZipBufferOptions
Type declaration
optionallevel?: ZipCompression
optionalreadOnly?: boolean
optionalstats?: Stats
Extracts the archive part (ending in the first instance of
extension
) from a path.The indexOf-based implementation is ~3.7x faster than a RegExp-based implementation.