/index.d.ts | zipjs@v2.7.42

import * as zipjs from "https://deno.land/x/zipjs@v2.7.42/index.d.ts";

Classes

c BlobReader	Represents a Reader instance used to read data provided as a `Blob` instance.
c BlobWriter	Represents a WritableWriter instance used to retrieve the written data as a `Blob` instance.
c Data64URIReader	Represents a Reader instance used to read data provided as a Data URI `string` encoded in Base64.
c Data64URIWriter	Represents a Writer instance used to retrieve the written data as a Data URI `string` encoded in Base64.
c FS	Represents a Filesystem instance.
c HttpRangeReader	Represents a Reader instance used to fetch data from servers returning `Accept-Ranges` headers.
c HttpReader	Represents a Reader instance used to fetch data from a URL.
c Reader	Represents an instance used to read unknown type of data.
c SplitDataReader	Represents a Reader instance used to read data provided as an array of ReadableReader instances (e.g. split zip files).
c SplitDataWriter	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).
c TextReader	Represents a Reader instance used to read data provided as a `string`.
c TextWriter	Represents a Writer instance used to retrieve the written data as a `string`.
c Uint8ArrayReader	Represents a Reader instance used to read data provided as a `Uint8Array` instance.
c Uint8ArrayWriter	Represents a Writer instance used to retrieve the written data as a `Uint8Array` instance.
c Writer	Represents an instance used to write unknown type of data.
c ZipDirectoryEntry	Represents a directory entry in the zip (Filesystem API).
c ZipFileEntry	Represents a file entry in the zip (Filesystem API).
c ZipReader	Represents an instance used to read a zip file.
c ZipReaderStream	Represents an instance used to create an unzipped stream.
c ZipWriter	Represents an instance used to create a zip file.
c ZipWriterStream	Represents an instance used to create a zipped stream.

Variables

v ERR_BAD_FORMAT	Zip format error
v ERR_CENTRAL_DIRECTORY_NOT_FOUND	Central Directory not found error
v ERR_DUPLICATED_NAME	Duplicate entry error
v ERR_ENCRYPTED	Encrypted entry error
v ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND	Zip64 End of Central Directory Locator not found error
v ERR_EOCDR_NOT_FOUND	End of Central Directory Record not found error
v ERR_EOCDR_ZIP64_NOT_FOUND	Zip64 End of Central Directory Record not found error
v ERR_EXTRAFIELD_ZIP64_NOT_FOUND	Extra field Zip64 not found error
v ERR_HTTP_RANGE	HTTP range error
v ERR_INVALID_COMMENT	Invalid comment error
v ERR_INVALID_ENCRYPTION_STRENGTH	Invalid encryption strength error
v ERR_INVALID_ENTRY_COMMENT	Invalid entry comment error
v ERR_INVALID_ENTRY_NAME	Invalid entry name error
v ERR_INVALID_EXTRAFIELD_DATA	Invalid extra field data error
v ERR_INVALID_EXTRAFIELD_TYPE	Invalid extra field type error
v ERR_INVALID_PASSWORD	Invalid password error
v ERR_INVALID_SIGNATURE	Invalid signature error
v ERR_INVALID_VERSION	Invalid version error
v ERR_ITERATOR_COMPLETED_TOO_SOON	Iteration completed too soon error
v ERR_LOCAL_FILE_HEADER_NOT_FOUND	Local file header not found error
v ERR_SPLIT_ZIP_FILE	Split zip file error
v ERR_UNSUPPORTED_COMPRESSION	Unsupported compression error
v ERR_UNSUPPORTED_ENCRYPTION	Unsupported encryption error
v ERR_UNSUPPORTED_FORMAT	Invalid format error
v fs	The Filesystem API.

Functions

f configure	Configures zip.js
f getMimeType	Returns the MIME type corresponding to a filename extension.
f initShimAsyncCodec	Transforms event-based third-party codec implementations into implementations compatible with zip.js
f terminateWorkers	Terminates all the web workers

Interfaces

I Configuration	Represents the configuration passed to configure.
I dataHandler	Represents the callback function used to handle `data` events.
I Entry	Represents an entry with its data and metadata in a zip file (Core API).
I EntryDataOnprogressOptions	Represents options passed to Entry#getData, ZipWriter.add and `ZipDirectory.export*`.
I EntryGetDataCheckPasswordOptions	Represents the options passed to Entry#getData and `[ZipFileEntry](https://deno.land/x/zipjs@v2.7.42/index.d.ts?s=ZipFileEntry).get*`.
I EntryGetDataOptions	Represents the options passed to Entry#getData and `[ZipFileEntry](https://deno.land/x/zipjs@v2.7.42/index.d.ts?s=ZipFileEntry).get*`.
I EntryMetaData	Represents the metadata of an entry in a zip file (Core API).
I EntryOnprogressOptions	Represents options passed to ZipReader#getEntries, ZipReader#getEntriesGenerator, and ZipWriter#close.
I EventBasedZipLibrary	Represents event-based implementations used to compress/decompress data.
I GetEntriesOptions	Represents options passed to the constructor of ZipReader, ZipReader#getEntries and ZipReader#getEntriesGenerator.
I HttpOptions	Represents the options passed to the constructor of HttpReader.
I HttpRangeOptions	Represents options passed to the constructor of HttpRangeReader and HttpReader.
I Initializable	Represents an instance used to read or write unknown type of data.
I ReadableReader	Represents an instance used to read data from a `ReadableStream` instance.
I registerDataHandler	Represents the callback function used to register the `data` event handler.
I WorkerConfiguration	Represents configuration passed to configure, the constructor of ZipReader, Entry#getData, the constructor of ZipWriter, and ZipWriter#add.
I WritableWriter	Represents an instance used to write data into a `WritableStream` instance.
I ZipDirectoryEntryExportOptions	Represents the options passed to `[ZipDirectoryEntry](https://deno.land/x/zipjs@v2.7.42/index.d.ts?s=ZipDirectoryEntry)#export*()`.
I ZipDirectoryEntryImportHttpOptions	Represents the options passed to ZipDirectoryEntry#importHttpContent.
I ZipLibrary	Represents the implementations zip.js uses to compress/decompress data.
I ZipReaderCheckPasswordOptions	Represents options passed to the constructor of ZipReader and Entry#getData.
I ZipReaderConstructorOptions	Represents the options passed to the constructor of ZipReader, and `ZipDirectory#import*`.
I ZipReaderGetEntriesOptions	Represents the options passed to ZipReader#getEntries and ZipReader#getEntriesGenerator.
I ZipReaderOptions	Represents options passed to the constructor of ZipReader and Entry#getData.
I ZipWriterAddDataOptions	Represents the options passed to ZipWriter#add.
I ZipWriterCloseOptions	Represents the options passed to ZipWriter#close.
I ZipWriterConstructorOptions	Represents options passed to the constructor of ZipWriter, ZipWriter#add and `[ZipDirectoryEntry](https://deno.land/x/zipjs@v2.7.42/index.d.ts?s=ZipDirectoryEntry)#export*`.