Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/zipjs/index.d.ts

JavaScript library to zip and unzip files supporting multi-core compression, compression streams, zip64, split files and encryption.
Go to Latest
import * as zipjs from "https://deno.land/x/zipjs@v2.7.36/index.d.ts";

Classes

Represents a Reader instance used to read data provided as a Blob instance.

Represents a WritableWriter instance used to retrieve the written data as a Blob instance.

Represents a Reader instance used to read data provided as a Data URI string encoded in Base64.

Represents a Writer instance used to retrieve the written data as a Data URI string encoded in Base64.

Represents a Filesystem instance.

Represents a Reader instance used to fetch data from servers returning Accept-Ranges headers.

Represents a Reader instance used to fetch data from a URL.

Represents an instance used to read unknown type of data.

Represents a Reader instance used to read data provided as an array of ReadableReader instances (e.g. split zip files).

Represents a Writer instance used to retrieve the written data from a generator of WritableWriter instances (i.e. split zip files).

c
SplitZipReader
deprecated

Represents a Reader instance used to read data provided as an array of ReadableReader instances (e.g. split zip files).

c
SplitZipWriter
deprecated

Represents a Writer instance used to retrieve the written data from a generator of WritableWriter instances (i.e. split zip files).

Represents a Reader instance used to read data provided as a string.

Represents a Writer instance used to retrieve the written data as a string.

Represents a Reader instance used to read data provided as a Uint8Array instance.

Represents a Writer instance used to retrieve the written data as a Uint8Array instance.

Represents an instance used to write unknown type of data.

Represents a directory entry in the zip (Filesystem API).

Represents a file entry in the zip (Filesystem API).

Represents an instance used to read a zip file.

Represents an instance used to create an unzipped stream.

Represents an instance used to create a zip file.

Represents an instance used to create a zipped stream.

Functions

Configures zip.js

Returns the MIME type corresponding to a filename extension.

Transforms event-based third-party codec implementations into implementations compatible with zip.js

Terminates all the web workers

Interfaces

Represents the configuration passed to configure.

Represents the callback function used to handle data events.

Represents an entry with its data and metadata in a zip file (Core API).

Represents options passed to Entry#getData, ZipWriter.add and ZipDirectory.export*.

Represents the options passed to Entry#getData and [ZipFileEntry](https://deno.land/x/zipjs@v2.7.36/index.d.ts?s=ZipFileEntry).get*.

Represents the options passed to Entry#getData and [ZipFileEntry](https://deno.land/x/zipjs@v2.7.36/index.d.ts?s=ZipFileEntry).get*.

Represents the metadata of an entry in a zip file (Core API).

Represents options passed to ZipReader#getEntries, ZipReader#getEntriesGenerator, and ZipWriter#close.

Represents event-based implementations used to compress/decompress data.

Represents options passed to the constructor of ZipReader, ZipReader#getEntries and ZipReader#getEntriesGenerator.

Represents the options passed to the constructor of HttpReader.

Represents options passed to the constructor of HttpRangeReader and HttpReader.

Represents an instance used to read or write unknown type of data.

Represents an instance used to read data from a ReadableStream instance.

Represents the callback function used to register the data event handler.

Represents configuration passed to configure, the constructor of ZipReader, Entry#getData, the constructor of ZipWriter, and ZipWriter#add.

Represents an instance used to write data into a WritableStream instance.

Represents the options passed to [ZipDirectoryEntry](https://deno.land/x/zipjs@v2.7.36/index.d.ts?s=ZipDirectoryEntry)#export*().

Represents the options passed to ZipDirectoryEntry#importHttpContent.

Represents the implementations zip.js uses to compress/decompress data.

Represents options passed to the constructor of ZipReader and Entry#getData.

Represents the options passed to the constructor of ZipReader, and ZipDirectory#import*.

Represents the options passed to ZipReader#getEntries and ZipReader#getEntriesGenerator.

Represents options passed to the constructor of ZipReader and Entry#getData.

Represents the options passed to ZipWriter#add.

Represents the options passed to ZipWriter#close.

Represents options passed to the constructor of ZipWriter, ZipWriter#add and [ZipDirectoryEntry](https://deno.land/x/zipjs@v2.7.36/index.d.ts?s=ZipDirectoryEntry)#export*.