Options
All
  • Public
  • Public/Protected
  • All
Menu

Package yarnpkg-libzip

@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

Enumerations

Type aliases

Variables

Functions

Type aliases

Libzip

Libzip: ReturnType<typeof makeInterface>

Variables

Let mod

mod: Libzip | null = null

Const number64

number64: ["number", "number"] = [`number`, // low`number`, // high] as const

Let promise

promise: Promise<Libzip> | null = null

Functions

getLibzipPromise

  • getLibzipPromise(): Promise<object>

getLibzipPromise

  • getLibzipPromise(): Promise<object>

getLibzipSync

  • getLibzipSync(): object

  • Returns object

    • 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_CREATE: 1
    • 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
    • ZIP_TRUNCATE: 8
    • close: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • delete: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • discard: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • errors: Errors
    • fclose: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • fopen: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • fopenIndex: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • fread: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • free: _free
    • getError: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • getName: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • getNumEntries: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • getValue: getValue
    • malloc: _malloc
    • open: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • openFromSource: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • stat: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • statIndex: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • uint08S: number
    • uint16S: number
    • uint32S: number
    • uint64S: number
    • HEAP8:
    • HEAPU8:
    • dir: object
      • add: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • error: object
      • initWithCode: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • strerror: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • ext: object
      • countSymlinks: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • file: object
      • add: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • getError: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • getExternalAttributes: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • setCompression: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • setExternalAttributes: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • setMtime: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • name: object
      • locate: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • source: object
      • close: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • error: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • free: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • fromBuffer: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • fromUnattachedBuffer: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • keep: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • open: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • read: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • seek: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • setMtime: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • tell: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • struct: object
      • error: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • errorCodeZip: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • errorS: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • stat: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statCompMethod: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statCompSize: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statCrc: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statIndex: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statMtime: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statName: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statS: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statSize: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

getLibzipSync

  • getLibzipSync(): void

Const makeInterface

  • makeInterface(libzip: LibzipEmscriptenModule): object

  • Parameters

    • libzip: LibzipEmscriptenModule

    Returns object

    • 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_CREATE: 1
    • 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
    • ZIP_TRUNCATE: 8
    • close: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • delete: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • discard: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • errors: Errors
    • fclose: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • fopen: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • fopenIndex: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • fread: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • free: _free
    • getError: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • getName: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • getNumEntries: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • getValue: getValue
    • malloc: _malloc
    • open: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • openFromSource: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • stat: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • statIndex: function
        • (...arg: ArgsToType<I>): ReturnToType<R>

        • Parameters

          • Rest ...arg: ArgsToType<I>

          Returns ReturnToType<R>

    • uint08S: number
    • uint16S: number
    • uint32S: number
    • uint64S: number
    • HEAP8:
    • HEAPU8:
    • dir: object
      • add: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • error: object
      • initWithCode: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • strerror: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • ext: object
      • countSymlinks: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • file: object
      • add: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • getError: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • getExternalAttributes: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • setCompression: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • setExternalAttributes: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • setMtime: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • name: object
      • locate: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • source: object
      • close: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • error: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • free: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • fromBuffer: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • fromUnattachedBuffer: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • keep: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • open: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • read: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • seek: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • setMtime: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • tell: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

    • struct: object
      • error: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • errorCodeZip: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • errorS: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • stat: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statCompMethod: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statCompSize: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statCrc: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statIndex: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statMtime: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statName: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statS: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

      • statSize: function
          • (...arg: ArgsToType<I>): ReturnToType<R>

          • Parameters

            • Rest ...arg: ArgsToType<I>

            Returns ReturnToType<R>

Generated using TypeDoc