@gyng/remote-zip
    Preparing search index...

    Class RemoteZipPointer

    An uninitialised pointer to a remote ZIP file.

    No network requests are sent until populate() is called.

    const url = new URL("http://www.example.com/test.zip");
    const remoteZip = await new RemoteZipPointer({ url }).populate();
    const fileListing = remoteZip.files(); // RemoteZipFile[]
    const uncompressedBytes = await remoteZip.fetch("test.txt"); // Uint8Array
    Index

    Constructors

    constructor

    Properties

    additionalHeaders? credentials headUrl method redirect? requestInit? signal? timeoutMs? url

    Methods

    populate

    Constructors

    • Parameters

      • __namedParameters: {
            additionalHeaders?: Headers;
            credentials?: "include" | "omit" | "same-origin";
            headUrl?: URL;
            method?: string;
            url: URL;
        } & Pick<
            RemoteZipRequestOptions,
            "redirect"
            | "signal"
            | "timeoutMs"
            | "requestInit",
        >
        • OptionaladditionalHeaders?: Headers

          Passed to fetch when performing a HTTP GET request for the file

        • Optionalcredentials?: "include" | "omit" | "same-origin"

          Passed to fetch when performing a HTTP GET request for the file

        • OptionalheadUrl?: URL

          URL for HEAD request. Defaults to url. This can, for example, differ from url if you are using a signed URL for S3.

        • Optionalmethod?: string

          Passed to fetch when performing a HTTP GET request for the file

        • url: URL

          URL for GET requests

      Returns RemoteZipPointer

    Properties

    additionalHeaders?: Headers

    Additional headers, if any, passed to fetch when calling url or headUrl

    credentials: "include" | "omit" | "same-origin"

    Credentials passed to fetch when retrieving files. Defaults to same-origin.

    headUrl: URL

    URL used when performing the HTTP HEAD request to fetch ZIP metadata

    method: string

    HTTP method used to fetch ZIP metadata (the initial HEAD request is always sent)

    redirect?: RequestRedirect

    Redirect mode passed to fetch. Defaults to "follow".

    requestInit?: RequestInit

    Extra RequestInit merged into every fetch.

    signal?: AbortSignal

    Signal that aborts in-flight requests.

    timeoutMs?: number

    Per-request timeout in milliseconds.

    url: URL

    URL of the remote ZIP archive

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods