Class RemoteZip

constructor

• new RemoteZip(__namedParameters): RemoteZip

• Parameters

  • __namedParameters: {
        centralDirectoryRecords: CentralDirectoryRecord[];
        contentLength: number;
        credentials: "include" | "omit" | "same-origin";
        endOfCentralDirectory: null | EndOfCentralDirectory;
        method: string;
        url: URL;
    }

    • centralDirectoryRecords: CentralDirectoryRecord[]

    • contentLength: number

      Length of the remote ZIP archive in bytes

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

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

    • endOfCentralDirectory: null | EndOfCentralDirectory

    • method: string

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

    • url: URL

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

  Returns RemoteZip

centralDirectoryRecords

contentLength

credentials

endOfCentralDirectory

method

url

fetch

• fetch(path, additionalHeaders?): Promise<ArrayBuffer>

• Gets a single uncompressed file in the remote ZIP archive.

  Parameters

  • path: string

    Path of the file in the remote ZIP archive

  • Optional additionalHeaders: Headers

    Additional headers, if any, to be passed to the fetch request

  Returns Promise<ArrayBuffer>

  Inflated (uncompressed) bytes of the requested file

  Throws

  RemoteZipError if it fails to parse or fetch

files

• files(): RemoteZipFile[]

• Get a formatted file listing of the remote ZIP archive.

  Returns RemoteZipFile[]

  List of files in the remote ZIP archive.

  import { RemoteZipPointer } from "remote-zip";
  
  const url = new URL("http://www.example.com/test.zip");
  const remoteZip = await new RemoteZipPointer({ url }).populate();
  const files = remoteZip.files();
  // files = [{ attributes: 1107099648, filename: "text.txt", modified: "2021-06-17T12:28:02", size: 14 }]
  Copy