Options
All
  • Public
  • Public/Protected
  • All
Menu

Used for creating IZipResourceProvider instances. IZipResourceProviders are used for extracting resources from ZIP archives. This implementation supports the STORE and DEFLATE compression methods and does not support any ZIP encryption algorithms.

Files are extracted using a WebWorker.

Index

Functions

createFromArrayBuffer

  • Creates a new ZipResourceProvider using the specified ArrayBuffer as source.

    If transfer is set to true, the ArrayBuffer is transferred to the WebWorker which will improve performance loading the zip archive. See https://developer.mozilla.org/en-US/docs/Web/API/Transferable

    Parameters

    • data: ArrayBuffer

      The full zip archive

    • transfer: boolean

      If true, transfers the ArrayBuffer to the WebWorker instance.

    Returns Promise<IZipResourceProvider>

    Resolved with an IZipResourceProvider if the zip archive loaded successfully.

createFromBase64

  • Creates a new ZipResourceProvider using a base64 encoded string as source.

    Parameters

    • data: string

      The full zip archive as a base64 string

    Returns Promise<IZipResourceProvider>

    Resolved with an IZipResourceProvider if the zip archive loaded successfully.

createFromBlob

  • Creates a new ZipResourceProvider using the specified Blob as source.

    If transfer is set to true, the ArrayBuffer is transferred to the WebWorker which will improve performance loading the zip archive. See https://developer.mozilla.org/en-US/docs/Web/API/Transferable

    Parameters

    • data: Blob

      The full zip archive

    Returns Promise<IZipResourceProvider>

    Resolved with an IZipResourceProvider if the zip archive loaded successfully.

createFromRandomAccessDataSource

  • Creates a new ZipResourceProvider using a IRandomAccessDataSource instance for fetching zip data.

    Parameters

    Returns Promise<IZipResourceProvider>

fetchZipArchiveInformation

  • Fetch zip archive information containing all file entries in the zip and their chunk byte range configuration.

    Parameters

    Returns Promise<IZipArchiveInformation>

Generated using TypeDoc