ZipWriter | /index.js | zipjs@v2.7.2

JavaScript library to zip and unzip files supporting multi-core compression, compression streams, zip64, split files and encryption.

gildas-lormeau/zip.js

Popular

Go to Latest

cli-deno dist lib tests

index.js (default module)

ERR_CENTRAL_DIRECTORY_NOT_FOUND

ERR_DUPLICATED_NAME

ERR_ENCRYPTED

ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND

ERR_EOCDR_NOT_FOUND

ERR_EOCDR_ZIP64_NOT_FOUND

ERR_EXTRAFIELD_ZIP64_NOT_FOUND

ERR_HTTP_RANGE

ERR_INVALID_COMMENT

ERR_INVALID_ENCRYPTION_STRENGTH

ERR_INVALID_ENTRY_COMMENT

ERR_INVALID_ENTRY_NAME

ERR_INVALID_EXTRAFIELD_DATA

ERR_INVALID_EXTRAFIELD_TYPE

ERR_INVALID_PASSWORD

ERR_INVALID_SIGNATURE

ERR_INVALID_VERSION

ERR_ITERATOR_COMPLETED_TOO_SOON

ERR_LOCAL_FILE_HEADER_NOT_FOUND

ERR_SPLIT_ZIP_FILE

ERR_UNSUPPORTED_COMPRESSION

ERR_UNSUPPORTED_ENCRYPTION

ERR_UNSUPPORTED_FORMAT

ERR_CENTRAL_DIRECTORY_NOT_FOUND

ERR_DUPLICATED_NAME

ERR_ENCRYPTED

ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND

ERR_EOCDR_NOT_FOUND

ERR_EOCDR_ZIP64_NOT_FOUND

ERR_EXTRAFIELD_ZIP64_NOT_FOUND

ERR_HTTP_RANGE

ERR_INVALID_COMMENT

ERR_INVALID_ENCRYPTION_STRENGTH

ERR_INVALID_ENTRY_COMMENT

ERR_INVALID_ENTRY_NAME

ERR_INVALID_EXTRAFIELD_DATA

ERR_INVALID_EXTRAFIELD_TYPE

ERR_INVALID_PASSWORD

ERR_INVALID_SIGNATURE

ERR_INVALID_VERSION

ERR_ITERATOR_COMPLETED_TOO_SOON

ERR_LOCAL_FILE_HEADER_NOT_FOUND

ERR_SPLIT_ZIP_FILE

ERR_UNSUPPORTED_COMPRESSION

ERR_UNSUPPORTED_ENCRYPTION

ERR_UNSUPPORTED_FORMAT

ERR_CENTRAL_DIRECTORY_NOT_FOUND

ERR_DUPLICATED_NAME

ERR_ENCRYPTED

ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND

ERR_EOCDR_NOT_FOUND

ERR_EOCDR_ZIP64_NOT_FOUND

ERR_EXTRAFIELD_ZIP64_NOT_FOUND

ERR_HTTP_RANGE

ERR_INVALID_COMMENT

ERR_INVALID_ENCRYPTION_STRENGTH

ERR_INVALID_ENTRY_COMMENT

ERR_INVALID_ENTRY_NAME

ERR_INVALID_EXTRAFIELD_DATA

ERR_INVALID_EXTRAFIELD_TYPE

ERR_INVALID_PASSWORD

ERR_INVALID_SIGNATURE

ERR_INVALID_VERSION

ERR_ITERATOR_COMPLETED_TOO_SOON

ERR_LOCAL_FILE_HEADER_NOT_FOUND

ERR_SPLIT_ZIP_FILE

ERR_UNSUPPORTED_COMPRESSION

ERR_UNSUPPORTED_ENCRYPTION

ERR_UNSUPPORTED_FORMAT

rollup-es5.config.dev.js

rollup-es5.config.js

rollup-fflate.config.dev.js

rollup-fflate.config.js

rollup.config.dev.js

rollup.config.js

method ZipWriter.prototype.add

import { ZipWriter } from "https://deno.land/x/zipjs@v2.7.2/index.js";

add<ReaderType>(

filename: string,

reader?:

| Reader<ReaderType>

| ReadableReader

| ReadableStream

| Reader<unknown>[]

| ReadableReader[]

| ReadableStream[]

options?: ZipWriterAddDataOptions,

): Promise<EntryMetaData>

Adds an entry into the zip file

Type Parameters

ReaderType

Parameters

filename: string

The filename of the entry.

optional

reader:

| Reader<ReaderType>

| ReadableReader

| ReadableStream

| Reader<unknown>[]

| ReadableReader[]

| ReadableStream[]

The Reader instance used to read the content of the entry.

optional

options: ZipWriterAddDataOptions

The options.

Returns

Promise<EntryMetaData>

A promise resolving to an EntryMetaData instance.