diff --git a/api/classes/BlobReader.html b/api/classes/BlobReader.html index 67ddb52e..e6a85b40 100644 --- a/api/classes/BlobReader.html +++ b/api/classes/BlobReader.html @@ -1,16 +1,16 @@ BlobReader | @zip.js/zip.js

Class BlobReader

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

readable size

Methods

init? readUint8Array

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns BlobReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file diff --git a/api/classes/BlobWriter.html b/api/classes/BlobWriter.html index 914ea3e9..d930adbc 100644 --- a/api/classes/BlobWriter.html +++ b/api/classes/BlobWriter.html @@ -1,12 +1,12 @@ BlobWriter | @zip.js/zip.js

Class BlobWriter

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

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

writable

Methods

getData init

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

getData

  • getData(): Promise<Blob>

  • Retrieves all the written data

    +

Returns BlobWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

getData

  • getData(): Promise<Blob>

  • Retrieves all the written data

    Returns Promise<Blob>

    A promise resolving to the written data.

    -

init

Settings

Member Visibility

Theme

On This Page

constructorwritablegetDatainit
\ No newline at end of file +

init

Settings

Member Visibility

Theme

On This Page

constructorwritablegetDatainit
\ No newline at end of file diff --git a/api/classes/CodecStream.html b/api/classes/CodecStream.html index 70ab59b0..f7a4774a 100644 --- a/api/classes/CodecStream.html +++ b/api/classes/CodecStream.html @@ -1,5 +1,5 @@ CodecStream | @zip.js/zip.js

Class CodecStream

Represents a class implementing CompressionStream or DecompressionStream interfaces.

-

Hierarchy

  • TransformStream
    • CodecStream

Constructors

constructor +

Hierarchy

  • TransformStream
    • CodecStream

Constructors

constructor

Properties

readable writable

Constructors

constructor

  • new CodecStream(transformer?, writableStrategy?, readableStrategy?): CodecStream

  • Parameters

    • Optional transformer: Transformer<any, any>
    • Optional writableStrategy: QueuingStrategy<any>
    • Optional readableStrategy: QueuingStrategy<any>

    Returns CodecStream

Properties

Readonly readable

readable: ReadableStream<any>

MDN Reference

diff --git a/api/classes/Data64URIReader.html b/api/classes/Data64URIReader.html index 003d1a0c..6a4d0be1 100644 --- a/api/classes/Data64URIReader.html +++ b/api/classes/Data64URIReader.html @@ -1,16 +1,16 @@ Data64URIReader | @zip.js/zip.js

Class Data64URIReader

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

readable size

Methods

init? readUint8Array

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns Data64URIReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file diff --git a/api/classes/Data64URIWriter.html b/api/classes/Data64URIWriter.html index 6c57a0b2..dd91e1e2 100644 --- a/api/classes/Data64URIWriter.html +++ b/api/classes/Data64URIWriter.html @@ -1,16 +1,16 @@ Data64URIWriter | @zip.js/zip.js

Class Data64URIWriter

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

writable

Methods

getData init? writeUint8Array

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

getData

  • getData(): Promise<string>

  • Retrieves all the written data

    +

Returns Data64URIWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

getData

  • getData(): Promise<string>

  • Retrieves all the written data

    Returns Promise<string>

    A promise resolving to the written data.

    -

Optional init

Optional init

  • init(size?): Promise<void>

  • Initializes the instance asynchronously

    Parameters

    • Optional size: number

      the total size of the written data in bytes.

      -

    Returns Promise<void>

writeUint8Array

  • writeUint8Array(array): Promise<void>

  • Appends a chunk of data

    +

Returns Promise<void>

writeUint8Array

  • writeUint8Array(array): Promise<void>

  • Appends a chunk of data

    Parameters

    • array: Uint8Array

      The chunk data to append.

      -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorwritablegetDatainitwriteUint8Array
\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorwritablegetDatainitwriteUint8Array
\ No newline at end of file diff --git a/api/classes/EventBasedCodec.html b/api/classes/EventBasedCodec.html index 8e9ef97a..9fb6d744 100644 --- a/api/classes/EventBasedCodec.html +++ b/api/classes/EventBasedCodec.html @@ -1,9 +1,9 @@ EventBasedCodec | @zip.js/zip.js

Class EventBasedCodec

Represents an event-based implementation of a third-party codec.

-

Constructors

constructor +

Constructors

constructor

Methods

ondata push

Constructors

constructor

Methods

ondata

  • ondata(data?): void

  • The function called when a chunk of data has been compressed/decompressed.

    Parameters

    • Optional data: Uint8Array

      The chunk of compressed/decompressed data.

      -

    Returns void

push

  • push(data): void

  • Appends a chunk of data to compress/decompress

    +

Returns void

push

  • push(data): void

  • Appends a chunk of data to compress/decompress

    Parameters

    • data: Uint8Array

      The chunk of data to append.

      -

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorondatapush
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructorondatapush
\ No newline at end of file diff --git a/api/classes/FS.html b/api/classes/FS.html index abce2571..38560390 100644 --- a/api/classes/FS.html +++ b/api/classes/FS.html @@ -2,7 +2,7 @@

Example

Here is an example showing how to create and read a zip file containing a compressed text file:

const TEXT_CONTENT = "Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.";
const FILENAME = "lorem.txt";
const BLOB = new Blob([TEXT_CONTENT], { type: zip.getMimeType(FILENAME) });
let zipFs = new zip.fs.FS();
zipFs.addBlob("lorem.txt", BLOB);
const zippedBlob = await zipFs.exportBlob();
zipFs = new zip.fs.FS();
await zipFs.importBlob(zippedBlob);
const firstEntry = zipFs.children[0];
const unzippedBlob = await firstEntry.getBlob(zip.getMimeType(firstEntry.name));
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

children data? directory @@ -45,116 +45,116 @@ remove rename

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

-

Optional data

data?: EntryMetaData

The underlying EntryMetaData instance.

-

directory

directory: true

true for ZipDirectoryEntry instances.

-

id

id: number

The ID of the instance.

-

name

name: string

The relative filename of the entry.

-

Optional parent

parent?: ZipEntry

The parent directory of the entry.

-

root

root: ZipDirectoryEntry

The root directory.

-

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

-

Methods

addBlob

Optional data

data?: EntryMetaData

The underlying EntryMetaData instance.

+

directory

directory: true

true for ZipDirectoryEntry instances.

+

id

id: number

The ID of the instance.

+

name

name: string

The relative filename of the entry.

+

Optional parent

parent?: ZipEntry

The parent directory of the entry.

+

root

root: ZipDirectoryEntry

The root directory.

+

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

+

Methods

addBlob

addData64URI

addData64URI

addDirectory

addDirectory

addFile

addFile

addFileSystemEntry

addFileSystemEntry

addFileSystemHandle

addFileSystemHandle

addHttpContent

addHttpContent

addReadable

addReadable

addText

addText

addUint8Array

addUint8Array

checkPassword

  • checkPassword(password, options?): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    -

    Parameters

    Returns Promise<boolean>

clone

checkPassword

  • checkPassword(password, options?): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    +

    Parameters

    Returns Promise<boolean>

clone

exportBlob

  • exportBlob(options?): Promise<Blob>

  • Returns a Blob instance containing a zip file of the entry and its descendants

    +

Returns ZipEntry

exportBlob

exportData64URI

exportData64URI

exportUint8Array

exportUint8Array

exportWritable

exportWritable

exportZip

exportZip

find

find

getById

getById

getChildByName

getChildByName

getFullname

getRelativeName

importBlob

getFullname

getRelativeName

importBlob

importData64URI

Returns Promise<[ZipEntry]>

importData64URI

importHttpContent

Returns Promise<[ZipEntry]>

importHttpContent

importReadable

Returns Promise<[ZipEntry]>

importReadable

importUint8Array

Returns Promise<[ZipEntry]>

importUint8Array

importZip

Returns Promise<[ZipEntry]>

importZip

isDescendantOf

Returns Promise<[ZipEntry]>

isDescendantOf

isPasswordProtected

move

Returns boolean

isPasswordProtected

move

remove

Returns void

remove

rename

Returns void

rename

Settings

Member Visibility

Theme

On This Page

constructorchildrendatadirectoryidnameparentrootuncompressedSizeaddBlobaddData64URIaddDirectoryaddFileaddFileSystemEntryaddFileSystemHandleaddHttpContentaddReadableaddTextaddUint8ArraycheckPasswordcloneexportBlobexportData64URIexportUint8ArrayexportWritableexportZipfindgetByIdgetChildByNamegetFullnamegetRelativeNameimportBlobimportData64URIimportHttpContentimportReadableimportUint8ArrayimportZipisDescendantOfisPasswordProtectedmoveremoverename
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructorchildrendatadirectoryidnameparentrootuncompressedSizeaddBlobaddData64URIaddDirectoryaddFileaddFileSystemEntryaddFileSystemHandleaddHttpContentaddReadableaddTextaddUint8ArraycheckPasswordcloneexportBlobexportData64URIexportUint8ArrayexportWritableexportZipfindgetByIdgetChildByNamegetFullnamegetRelativeNameimportBlobimportData64URIimportHttpContentimportReadableimportUint8ArrayimportZipisDescendantOfisPasswordProtectedmoveremoverename
\ No newline at end of file diff --git a/api/classes/HttpRangeReader.html b/api/classes/HttpRangeReader.html index c22498d2..fec7fc2c 100644 --- a/api/classes/HttpRangeReader.html +++ b/api/classes/HttpRangeReader.html @@ -1,5 +1,5 @@ HttpRangeReader | @zip.js/zip.js

Class HttpRangeReader

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

readable size

Methods

init? @@ -7,11 +7,11 @@

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optional init

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns HttpRangeReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optional init

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file diff --git a/api/classes/HttpReader.html b/api/classes/HttpReader.html index 3001baa7..db3d84ee 100644 --- a/api/classes/HttpReader.html +++ b/api/classes/HttpReader.html @@ -1,5 +1,5 @@ HttpReader | @zip.js/zip.js

Class HttpReader

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

readable size

Methods

init? @@ -7,11 +7,11 @@

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns HttpReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file diff --git a/api/classes/Reader.html b/api/classes/Reader.html index 4a2484d3..de54f8ed 100644 --- a/api/classes/Reader.html +++ b/api/classes/Reader.html @@ -2,18 +2,18 @@

Example

Here is an example of custom Reader class used to read binary strings:

class BinaryStringReader extends Reader {

  constructor(binaryString) {
    super();
    this.binaryString = binaryString;
  }

  init() {
    super.init();
    this.size = this.binaryString.length;
  }

  readUint8Array(offset, length) {
    const result = new Uint8Array(length);
    for (let indexCharacter = 0; indexCharacter < length; indexCharacter++) {
      result[indexCharacter] = this.binaryString.charCodeAt(indexCharacter + offset) & 0xFF;
    }
    return result;
  }
}
-

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

  • Type

Hierarchy (view full)

Implements

Constructors

constructor

Properties

readable size

Methods

init? readUint8Array

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optional init

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns Reader<Type>

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optional init

readUint8Array

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file diff --git a/api/classes/SplitDataReader.html b/api/classes/SplitDataReader.html index 2a1b5006..ee8d4c54 100644 --- a/api/classes/SplitDataReader.html +++ b/api/classes/SplitDataReader.html @@ -1,16 +1,16 @@ SplitDataReader | @zip.js/zip.js

Class SplitDataReader

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

readable size

Methods

init? readUint8Array

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns SplitDataReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file diff --git a/api/classes/SplitDataWriter.html b/api/classes/SplitDataWriter.html index 2a53bf50..be611209 100644 --- a/api/classes/SplitDataWriter.html +++ b/api/classes/SplitDataWriter.html @@ -1,10 +1,10 @@ SplitDataWriter | @zip.js/zip.js

Class SplitDataWriter

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

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

writable

Methods

init

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

init

Settings

Member Visibility

Theme

On This Page

constructorwritableinit
\ No newline at end of file +

Returns SplitDataWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

init

Settings

Member Visibility

Theme

On This Page

constructorwritableinit
\ No newline at end of file diff --git a/api/classes/SplitZipReader.html b/api/classes/SplitZipReader.html index d6c5b60f..b97cfb7f 100644 --- a/api/classes/SplitZipReader.html +++ b/api/classes/SplitZipReader.html @@ -1,17 +1,17 @@ SplitZipReader | @zip.js/zip.js

Class SplitZipReader

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

Deprecated

Use SplitDataReader instead.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

readable size

Methods

init? readUint8Array

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optional init

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns SplitZipReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optional init

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file diff --git a/api/classes/SplitZipWriter.html b/api/classes/SplitZipWriter.html index 36324d00..a713a0bd 100644 --- a/api/classes/SplitZipWriter.html +++ b/api/classes/SplitZipWriter.html @@ -1,11 +1,11 @@ SplitZipWriter | @zip.js/zip.js

Class SplitZipWriter

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

Deprecated

Use SplitDataWriter instead.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

writable

Methods

init

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

init

Settings

Member Visibility

Theme

On This Page

constructorwritableinit
\ No newline at end of file +

Returns SplitZipWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

init

Settings

Member Visibility

Theme

On This Page

constructorwritableinit
\ No newline at end of file diff --git a/api/classes/SyncCodec.html b/api/classes/SyncCodec.html index 782aabbb..e7b5d926 100644 --- a/api/classes/SyncCodec.html +++ b/api/classes/SyncCodec.html @@ -1,6 +1,6 @@ -SyncCodec | @zip.js/zip.js

Class SyncCodec

Hierarchy (view full)

Constructors

constructor +SyncCodec | @zip.js/zip.js

Class SyncCodec

Hierarchy (view full)

Constructors

constructor

Methods

append

Constructors

constructor

Methods

append

  • append(data): Uint8Array

  • Appends a chunk of decompressed data to compress

    Parameters

    • data: Uint8Array

      The chunk of decompressed data to append.

    Returns Uint8Array

    A chunk of compressed data.

    -

Settings

Member Visibility

Theme

On This Page

constructorappend
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorappend
\ No newline at end of file diff --git a/api/classes/TextReader.html b/api/classes/TextReader.html index 616bddd8..6524b97c 100644 --- a/api/classes/TextReader.html +++ b/api/classes/TextReader.html @@ -1,16 +1,16 @@ TextReader | @zip.js/zip.js

Class TextReader

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

readable size

Methods

init? readUint8Array

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns TextReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file diff --git a/api/classes/TextWriter.html b/api/classes/TextWriter.html index 091ed47d..33fd28f2 100644 --- a/api/classes/TextWriter.html +++ b/api/classes/TextWriter.html @@ -1,16 +1,16 @@ TextWriter | @zip.js/zip.js

Class TextWriter

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

writable

Methods

getData init? writeUint8Array

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

getData

  • getData(): Promise<string>

  • Retrieves all the written data

    +

Returns TextWriter

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

+

Methods

getData

  • getData(): Promise<string>

  • Retrieves all the written data

    Returns Promise<string>

    A promise resolving to the written data.

    -

Optional init

Optional init

  • init(size?): Promise<void>

  • Initializes the instance asynchronously

    Parameters

    • Optional size: number

      the total size of the written data in bytes.

      -

    Returns Promise<void>

writeUint8Array

  • writeUint8Array(array): Promise<void>

  • Appends a chunk of data

    +

Returns Promise<void>

writeUint8Array

Settings

Member Visibility

Theme

On This Page

constructorwritablegetDatainitwriteUint8Array
\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorwritablegetDatainitwriteUint8Array
\ No newline at end of file diff --git a/api/classes/TransformStreamLike.html b/api/classes/TransformStreamLike.html index e58d6de0..1951275c 100644 --- a/api/classes/TransformStreamLike.html +++ b/api/classes/TransformStreamLike.html @@ -1,8 +1,8 @@ TransformStreamLike | @zip.js/zip.js

Class TransformStreamLike

Represents a generic TransformStream class.

See

https://streams.spec.whatwg.org/#generictransformstream|specification

-

Constructors

constructor +

Constructors

constructor

Properties

readable writable

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The readable stream.

-

writable

writable: WritableStream<any>

The writable stream.

-

Settings

Member Visibility

Theme

On This Page

constructorreadablewritable
\ No newline at end of file +

writable

writable: WritableStream<any>

The writable stream.

+

Settings

Member Visibility

Theme

On This Page

constructorreadablewritable
\ No newline at end of file diff --git a/api/classes/Uint8ArrayReader.html b/api/classes/Uint8ArrayReader.html index e622d522..944b5347 100644 --- a/api/classes/Uint8ArrayReader.html +++ b/api/classes/Uint8ArrayReader.html @@ -1,16 +1,16 @@ Uint8ArrayReader | @zip.js/zip.js

Class Uint8ArrayReader

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

-

Hierarchy (view full)

  • Reader<Uint8Array>
    • Uint8ArrayReader

Constructors

constructor +

Hierarchy (view full)

  • Reader<Uint8Array>
    • Uint8ArrayReader

Constructors

constructor

Properties

readable size

Methods

init? readUint8Array

Constructors

constructor

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

-

size

size: number

The total size of the data in bytes.

-

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    -

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    +

Returns Uint8ArrayReader

Properties

readable

readable: ReadableStream<any>

The ReadableStream instance.

+

size

size: number

The total size of the data in bytes.

+

Methods

Optional init

  • init(): Promise<void>

  • Initializes the instance asynchronously

    +

    Returns Promise<void>

readUint8Array

  • readUint8Array(index, length): Promise<Uint8Array>

  • Reads a chunk of data

    Parameters

    • index: number

      The byte index of the data to read.

    • length: number

      The length of the data to read in bytes.

    Returns Promise<Uint8Array>

    A promise resolving to a chunk of data.

    -

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorreadablesizeinitreadUint8Array
\ No newline at end of file diff --git a/api/classes/Uint8ArrayWriter.html b/api/classes/Uint8ArrayWriter.html index 5c43e972..0b9e6124 100644 --- a/api/classes/Uint8ArrayWriter.html +++ b/api/classes/Uint8ArrayWriter.html @@ -1,14 +1,14 @@ Uint8ArrayWriter | @zip.js/zip.js

Class Uint8ArrayWriter

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

-

Hierarchy (view full)

  • Writer<Uint8Array>
    • Uint8ArrayWriter

Constructors

constructor +

Hierarchy (view full)

  • Writer<Uint8Array>
    • Uint8ArrayWriter

Constructors

constructor

Properties

writable

Methods

getData init? writeUint8Array

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

getData

Methods

getData

  • getData(): Promise<Uint8Array>

  • Retrieves all the written data

    Returns Promise<Uint8Array>

    A promise resolving to the written data.

    -

Optional init

Optional init

  • init(size?): Promise<void>

  • Initializes the instance asynchronously

    Parameters

    • Optional size: number

      the total size of the written data in bytes.

      -

    Returns Promise<void>

writeUint8Array

  • writeUint8Array(array): Promise<void>

  • Appends a chunk of data

    +

Returns Promise<void>

writeUint8Array

  • writeUint8Array(array): Promise<void>

  • Appends a chunk of data

    Parameters

    • array: Uint8Array

      The chunk data to append.

      -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorwritablegetDatainitwriteUint8Array
\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorwritablegetDatainitwriteUint8Array
\ No newline at end of file diff --git a/api/classes/Writer.html b/api/classes/Writer.html index 250ecdef..d4337550 100644 --- a/api/classes/Writer.html +++ b/api/classes/Writer.html @@ -2,16 +2,16 @@

Example

Here is an example of custom Writer class used to write binary strings:

class BinaryStringWriter extends Writer {

  constructor() {
    super();
    this.binaryString = "";
  }

  writeUint8Array(array) {
    for (let indexCharacter = 0; indexCharacter < array.length; indexCharacter++) {
      this.binaryString += String.fromCharCode(array[indexCharacter]);
    }
  }

  getData() {
    return this.binaryString;
  }
}
-

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

  • Type

Hierarchy (view full)

Implements

Constructors

constructor

Properties

writable

Methods

getData init? writeUint8Array

Constructors

constructor

Properties

writable

writable: WritableStream<any>

The WritableStream instance.

-

Methods

getData

Methods

getData

  • getData(): Promise<Type>

  • Retrieves all the written data

    Returns Promise<Type>

    A promise resolving to the written data.

    -

Optional init

  • init(size?): Promise<void>

  • Initializes the instance asynchronously

    +

Optional init

  • init(size?): Promise<void>

  • Initializes the instance asynchronously

    Parameters

    • Optional size: number

      the total size of the written data in bytes.

      -

    Returns Promise<void>

writeUint8Array

  • writeUint8Array(array): Promise<void>

  • Appends a chunk of data

    +

Returns Promise<void>

writeUint8Array

Settings

Member Visibility

Theme

On This Page

constructorwritablegetDatainitwriteUint8Array
\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorwritablegetDatainitwriteUint8Array
\ No newline at end of file diff --git a/api/classes/ZipDeflate.html b/api/classes/ZipDeflate.html index fb3abd9f..cb0bfdee 100644 --- a/api/classes/ZipDeflate.html +++ b/api/classes/ZipDeflate.html @@ -1,10 +1,10 @@ ZipDeflate | @zip.js/zip.js

Class ZipDeflate

Represents an instance used to compress data.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

append flush

Constructors

constructor

Methods

append

  • append(data): Uint8Array

  • Appends a chunk of decompressed data to compress

    Parameters

    • data: Uint8Array

      The chunk of decompressed data to append.

    Returns Uint8Array

    A chunk of compressed data.

    -

flush

flush

  • flush(): Uint8Array

  • Flushes the data

    Returns Uint8Array

    A chunk of compressed data.

    -

Settings

Member Visibility

Theme

On This Page

constructorappendflush
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorappendflush
\ No newline at end of file diff --git a/api/classes/ZipDirectoryEntry.html b/api/classes/ZipDirectoryEntry.html index e7a93954..bf69e063 100644 --- a/api/classes/ZipDirectoryEntry.html +++ b/api/classes/ZipDirectoryEntry.html @@ -1,5 +1,5 @@ ZipDirectoryEntry | @zip.js/zip.js

Class ZipDirectoryEntry

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

children data? directory @@ -37,104 +37,104 @@ isPasswordProtected rename

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

-

Optional data

data?: EntryMetaData

The underlying EntryMetaData instance.

-

directory

directory: true

true for ZipDirectoryEntry instances.

-

id

id: number

The ID of the instance.

-

name

name: string

The relative filename of the entry.

-

Optional parent

parent?: ZipEntry

The parent directory of the entry.

-

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

-

Methods

addBlob

Optional data

data?: EntryMetaData

The underlying EntryMetaData instance.

+

directory

directory: true

true for ZipDirectoryEntry instances.

+

id

id: number

The ID of the instance.

+

name

name: string

The relative filename of the entry.

+

Optional parent

parent?: ZipEntry

The parent directory of the entry.

+

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

+

Methods

addBlob

addData64URI

  • addData64URI(name, dataURI, options?): ZipFileEntry<string, string>

  • Adds a entry entry with content provided as a Data URI string encoded in Base64

    +

addData64URI

  • addData64URI(name, dataURI, options?): ZipFileEntry<string, string>

  • Adds a entry entry with content provided as a Data URI string encoded in Base64

    Parameters

    • name: string

      The relative filename of the entry.

    • dataURI: string

      The Data URI string encoded in Base64.

    • Optional options: ZipWriterAddDataOptions

      The options.

    Returns ZipFileEntry<string, string>

    A ZipFileEntry instance.

    -

addDirectory

addDirectory

addFile

  • addFile(file, options?): Promise<ZipEntry>

  • Adds an entry with content provided via a File instance

    +

addFile

addFileSystemEntry

  • addFileSystemEntry(fileSystemEntry, options?): Promise<ZipEntry[]>

  • Adds an entry with content provided via a FileSystemEntry instance

    +

addFileSystemEntry

addFileSystemHandle

  • addFileSystemHandle(fileSystemHandle, options?): Promise<ZipEntry[]>

  • Adds an entry with content provided via a FileSystemHandle instance

    +

addFileSystemHandle

addHttpContent

  • addHttpContent(name, url, options?): ZipFileEntry<string, void>

  • Adds an entry with content fetched from a URL

    +

addHttpContent

addReadable

  • addReadable(name, readable, options?): ZipFileEntry<ReadableStream<any>, void>

  • Adds a entry entry with content provided via a ReadableStream instance

    +

addReadable

  • addReadable(name, readable, options?): ZipFileEntry<ReadableStream<any>, void>

  • Adds a entry entry with content provided via a ReadableStream instance

    Parameters

    • name: string

      The relative filename of the entry.

    • readable: ReadableStream<any>

      The ReadableStream instance.

    • Optional options: ZipWriterAddDataOptions

      The options.

    Returns ZipFileEntry<ReadableStream<any>, void>

    A ZipFileEntry instance.

    -

addText

addText

addUint8Array

  • addUint8Array(name, array, options?): ZipFileEntry<Uint8Array, Uint8Array>

  • Adds an entry with content provided as a Uint8Array instance

    +

addUint8Array

  • addUint8Array(name, array, options?): ZipFileEntry<Uint8Array, Uint8Array>

  • Adds an entry with content provided as a Uint8Array instance

    Parameters

    • name: string

      The relative filename of the entry.

    • array: Uint8Array

      The Uint8Array instance.

    • Optional options: ZipWriterAddDataOptions

      The options.

    Returns ZipFileEntry<Uint8Array, Uint8Array>

    A ZipFileEntry instance.

    -

checkPassword

  • checkPassword(password, options?): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    -

    Parameters

    Returns Promise<boolean>

clone

checkPassword

  • checkPassword(password, options?): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    +

    Parameters

    Returns Promise<boolean>

clone

exportBlob

  • exportBlob(options?): Promise<Blob>

  • Returns a Blob instance containing a zip file of the entry and its descendants

    +

Returns ZipEntry

exportBlob

  • exportBlob(options?): Promise<Blob>

  • Returns a Blob instance containing a zip file of the entry and its descendants

    Parameters

    Returns Promise<Blob>

    A promise resolving to the Blob instance.

    -

exportData64URI

  • exportData64URI(options?): Promise<string>

  • Returns a Data URI string encoded in Base64 containing a zip file of the entry and its descendants

    +

exportData64URI

  • exportData64URI(options?): Promise<string>

  • Returns a Data URI string encoded in Base64 containing a zip file of the entry and its descendants

    Parameters

    Returns Promise<string>

    A promise resolving to the Data URI string encoded in Base64.

    -

exportUint8Array

  • exportUint8Array(options?): Promise<Uint8Array>

  • Returns a Uint8Array instance containing a zip file of the entry and its descendants

    +

exportUint8Array

  • exportUint8Array(options?): Promise<Uint8Array>

  • Returns a Uint8Array instance containing a zip file of the entry and its descendants

    Parameters

    Returns Promise<Uint8Array>

    A promise resolving to the Uint8Array instance.

    -

exportWritable

  • exportWritable(writable?, options?): Promise<WritableStream<any>>

  • Creates a zip file via a WritableStream instance containing the entry and its descendants

    +

exportWritable

  • exportWritable(writable?, options?): Promise<WritableStream<any>>

  • Creates a zip file via a WritableStream instance containing the entry and its descendants

    Parameters

    Returns Promise<WritableStream<any>>

    A promise resolving to the Uint8Array instance.

    -

exportZip

  • exportZip(writer, options?): Promise<unknown>

  • Creates a zip file via a custom Writer instance containing the entry and its descendants

    +

exportZip

getChildByName

getChildByName

getFullname

getRelativeName

importBlob

  • importBlob(blob, options?): Promise<[ZipEntry]>

  • Extracts a zip file provided as a Blob instance into the entry

    +

getFullname

getRelativeName

importBlob

importData64URI

  • importData64URI(dataURI, options?): Promise<[ZipEntry]>

  • Extracts a zip file provided as a Data URI string encoded in Base64 into the entry

    +

Returns Promise<[ZipEntry]>

importData64URI

importHttpContent

Returns Promise<[ZipEntry]>

importHttpContent

importReadable

Returns Promise<[ZipEntry]>

importReadable

importUint8Array

Returns Promise<[ZipEntry]>

importUint8Array

importZip

Returns Promise<[ZipEntry]>

importZip

isDescendantOf

Returns Promise<[ZipEntry]>

isDescendantOf

isPasswordProtected

rename

Returns boolean

isPasswordProtected

rename

Settings

Member Visibility

Theme

On This Page

constructorchildrendatadirectoryidnameparentuncompressedSizeaddBlobaddData64URIaddDirectoryaddFileaddFileSystemEntryaddFileSystemHandleaddHttpContentaddReadableaddTextaddUint8ArraycheckPasswordcloneexportBlobexportData64URIexportUint8ArrayexportWritableexportZipgetChildByNamegetFullnamegetRelativeNameimportBlobimportData64URIimportHttpContentimportReadableimportUint8ArrayimportZipisDescendantOfisPasswordProtectedrename
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructorchildrendatadirectoryidnameparentuncompressedSizeaddBlobaddData64URIaddDirectoryaddFileaddFileSystemEntryaddFileSystemHandleaddHttpContentaddReadableaddTextaddUint8ArraycheckPasswordcloneexportBlobexportData64URIexportUint8ArrayexportWritableexportZipgetChildByNamegetFullnamegetRelativeNameimportBlobimportData64URIimportHttpContentimportReadableimportUint8ArrayimportZipisDescendantOfisPasswordProtectedrename
\ No newline at end of file diff --git a/api/classes/ZipEntry.html b/api/classes/ZipEntry.html index 8874d00b..7cb3f2e9 100644 --- a/api/classes/ZipEntry.html +++ b/api/classes/ZipEntry.html @@ -1,5 +1,5 @@ ZipEntry | @zip.js/zip.js

Class ZipEntry

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

children data? id @@ -14,19 +14,19 @@ isPasswordProtected rename

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

-

Optional data

data?: EntryMetaData

The underlying EntryMetaData instance.

-

id

id: number

The ID of the instance.

-

name

name: string

The relative filename of the entry.

-

Optional parent

parent?: ZipEntry

The parent directory of the entry.

-

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

-

Methods

checkPassword

  • checkPassword(password, options?): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    -

    Parameters

    Returns Promise<boolean>

clone

Optional data

data?: EntryMetaData

The underlying EntryMetaData instance.

+

id

id: number

The ID of the instance.

+

name

name: string

The relative filename of the entry.

+

Optional parent

parent?: ZipEntry

The parent directory of the entry.

+

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

+

Methods

checkPassword

  • checkPassword(password, options?): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    +

    Parameters

    Returns Promise<boolean>

clone

  • clone(deepClone?): ZipEntry

  • Clones the entry

    Parameters

    • Optional deepClone: boolean

      true to clone all the descendants.

      -

    Returns ZipEntry

getFullname

  • getFullname(): string

  • Returns the full filename of the entry

    -

    Returns string

getRelativeName

  • getRelativeName(ancestor): string

  • Returns the filename of the entry relative to a parent directory

    -

    Parameters

    Returns string

isDescendantOf

  • isDescendantOf(ancestor): boolean

  • Tests if a ZipDirectoryEntry instance is an ancestor of the entry

    +

Returns ZipEntry

getFullname

  • getFullname(): string

  • Returns the full filename of the entry

    +

    Returns string

getRelativeName

  • getRelativeName(ancestor): string

  • Returns the filename of the entry relative to a parent directory

    +

    Parameters

    Returns string

isDescendantOf

isPasswordProtected

  • isPasswordProtected(): boolean

  • Tests if the entry or any of its children is password protected

    -

    Returns boolean

rename

  • rename(name): void

  • Set the name of the entry

    +

Returns boolean

isPasswordProtected

rename

Settings

Member Visibility

Theme

On This Page

constructorchildrendataidnameparentuncompressedSizecheckPasswordclonegetFullnamegetRelativeNameisDescendantOfisPasswordProtectedrename
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructorchildrendataidnameparentuncompressedSizecheckPasswordclonegetFullnamegetRelativeNameisDescendantOfisPasswordProtectedrename
\ No newline at end of file diff --git a/api/classes/ZipFileEntry.html b/api/classes/ZipFileEntry.html index 3bb67903..f093722a 100644 --- a/api/classes/ZipFileEntry.html +++ b/api/classes/ZipFileEntry.html @@ -1,5 +1,5 @@ ZipFileEntry | @zip.js/zip.js

Class ZipFileEntry<ReaderType, WriterType>

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

-

Type Parameters

  • ReaderType
  • WriterType

Hierarchy (view full)

Constructors

constructor +

Type Parameters

  • ReaderType
  • WriterType

Hierarchy (view full)

Constructors

constructor

Properties

children data? directory @@ -28,55 +28,55 @@ replaceText replaceUint8Array

Constructors

constructor

Properties

children

children: ZipEntry[]

The children of the entry.

-

Optional data

data?: EntryMetaData

The underlying EntryMetaData instance.

-

directory

directory: void

void for ZipFileEntry instances.

-

id

id: number

The ID of the instance.

-

name

name: string

The relative filename of the entry.

-

Optional parent

parent?: ZipEntry

The parent directory of the entry.

-

reader

reader: ReadableStream<any> | ReadableReader | Reader<unknown>[] | ReadableReader[] | ReadableStream<any>[] | Reader<ReaderType>

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

-

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

-

writer

writer: WritableStream<any> | WritableWriter | Writer<WriterType> | AsyncGenerator<WritableStream<any> | WritableWriter | Writer<unknown>, any, unknown>

The Writer instance used to write the content of the entry.

-

Methods

checkPassword

  • checkPassword(password, options?): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    -

    Parameters

    Returns Promise<boolean>

clone

Optional data

data?: EntryMetaData

The underlying EntryMetaData instance.

+

directory

directory: void

void for ZipFileEntry instances.

+

id

id: number

The ID of the instance.

+

name

name: string

The relative filename of the entry.

+

Optional parent

parent?: ZipEntry

The parent directory of the entry.

+

reader

reader: ReadableStream<any> | ReadableReader | Reader<unknown>[] | ReadableReader[] | ReadableStream<any>[] | Reader<ReaderType>

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

+

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

+

writer

writer: WritableStream<any> | WritableWriter | Writer<WriterType> | AsyncGenerator<WritableStream<any> | WritableWriter | Writer<unknown>, any, unknown>

The Writer instance used to write the content of the entry.

+

Methods

checkPassword

  • checkPassword(password, options?): Promise<boolean>

  • Tests the password on the entry and all children if any, returns true if the entry is not password protected

    +

    Parameters

    Returns Promise<boolean>

clone

getBlob

  • getBlob(mimeType?, options?): Promise<Blob>

  • Retrieves the content of the entry as a Blob instance

    +

Returns ZipEntry

getBlob

  • getBlob(mimeType?, options?): Promise<Blob>

  • Retrieves the content of the entry as a Blob instance

    Parameters

    • Optional mimeType: string

      The MIME type of the content.

    • Optional options: EntryGetDataOptions

      The options.

    Returns Promise<Blob>

    A promise resolving to a Blob instance.

    -

getData

  • getData(writer, options?): Promise<unknown>

  • Retrieves the content of the entry via a Writer instance

    +

getData

getData64URI

  • getData64URI(mimeType?, options?): Promise<string>

  • Retrieves the content of the entry as as a Data URI string encoded in Base64

    +

getData64URI

  • getData64URI(mimeType?, options?): Promise<string>

  • Retrieves the content of the entry as as a Data URI string encoded in Base64

    Parameters

    • Optional mimeType: string

      The MIME type of the content.

    • Optional options: EntryGetDataOptions

      The options.

    Returns Promise<string>

    A promise resolving to a Data URI string encoded in Base64.

    -

getFullname

getRelativeName

getText

  • getText(encoding?, options?): Promise<string>

  • Retrieves the text content of the entry as a string

    +

getFullname

getRelativeName

getText

  • getText(encoding?, options?): Promise<string>

  • Retrieves the text content of the entry as a string

    Parameters

    • Optional encoding: string

      The encoding of the text.

    • Optional options: EntryGetDataOptions

      The options.

    Returns Promise<string>

    A promise resolving to a string.

    -

getUint8Array

  • getUint8Array(options?): Promise<Uint8Array>

  • Retrieves the content of the entry as a Uint8Array instance

    +

getUint8Array

  • getUint8Array(options?): Promise<Uint8Array>

  • Retrieves the content of the entry as a Uint8Array instance

    Parameters

    Returns Promise<Uint8Array>

    A promise resolving to a Uint8Array instance.

    -

getWritable

  • getWritable(writable?, options?): Promise<WritableStream<any>>

  • Retrieves the content of the entry via a WritableStream instance

    +

getWritable

  • getWritable(writable?, options?): Promise<WritableStream<any>>

  • Retrieves the content of the entry via a WritableStream instance

    Parameters

    • Optional writable: WritableStream<any>

      The WritableStream instance.

    • Optional options: EntryGetDataOptions

      The options.

    Returns Promise<WritableStream<any>>

    A promise resolving to the WritableStream instance.

    -

isDescendantOf

isDescendantOf

isPasswordProtected

rename

  • rename(name): void

  • Set the name of the entry

    +

Returns boolean

isPasswordProtected

rename

replaceBlob

Returns void

replaceBlob

replaceData64URI

Returns void

replaceData64URI

replaceReadable

Returns void

replaceReadable

replaceText

Returns void

replaceText

replaceUint8Array

Returns void

replaceUint8Array

Settings

Member Visibility

Theme

On This Page

constructorchildrendatadirectoryidnameparentreaderuncompressedSizewritercheckPasswordclonegetBlobgetDatagetData64URIgetFullnamegetRelativeNamegetTextgetUint8ArraygetWritableisDescendantOfisPasswordProtectedrenamereplaceBlobreplaceData64URIreplaceReadablereplaceTextreplaceUint8Array
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructorchildrendatadirectoryidnameparentreaderuncompressedSizewritercheckPasswordclonegetBlobgetDatagetData64URIgetFullnamegetRelativeNamegetTextgetUint8ArraygetWritableisDescendantOfisPasswordProtectedrenamereplaceBlobreplaceData64URIreplaceReadablereplaceTextreplaceUint8Array
\ No newline at end of file diff --git a/api/classes/ZipInflate.html b/api/classes/ZipInflate.html index c71d719c..6a930221 100644 --- a/api/classes/ZipInflate.html +++ b/api/classes/ZipInflate.html @@ -1,9 +1,9 @@ ZipInflate | @zip.js/zip.js

Class ZipInflate

Represents a codec used to decompress data.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

append flush

Constructors

constructor

Methods

append

  • append(data): Uint8Array

  • Appends a chunk of decompressed data to compress

    Parameters

    • data: Uint8Array

      The chunk of decompressed data to append.

    Returns Uint8Array

    A chunk of compressed data.

    -

flush

Settings

Member Visibility

Theme

On This Page

constructorappendflush
\ No newline at end of file +

flush

Settings

Member Visibility

Theme

On This Page

constructorappendflush
\ No newline at end of file diff --git a/api/classes/ZipReader.html b/api/classes/ZipReader.html index 3c68dd2d..c6444d13 100644 --- a/api/classes/ZipReader.html +++ b/api/classes/ZipReader.html @@ -2,7 +2,7 @@

Example

Here is an example showing how to read the text data of the first entry from a zip file:

// create a BlobReader to read with a ZipReader the zip from a Blob object
const reader = new zip.ZipReader(new zip.BlobReader(blob));

// get all entries from the zip
const entries = await reader.getEntries();
if (entries.length) {

  // get first entry content as text by using a TextWriter
  const text = await entries[0].getData(
    // writer
    new zip.TextWriter(),
    // options
    {
      onprogress: (index, max) => {
        // onprogress callback
      }
    }
  );
  // text contains the entry data as a String
  console.log(text);
}

// close the ZipReader
await reader.close();
-

Type Parameters

Constructors

constructor +

Type Parameters

  • Type

Constructors

constructor

Properties

appendedData? comment prependedData? @@ -12,14 +12,14 @@

Constructors

constructor

Properties

Optional appendedData

appendedData?: Uint8Array

The data appended after the zip file.

-

comment

comment: Uint8Array

The global comment of the zip file.

-

Optional prependedData

prependedData?: Uint8Array

The data prepended before the zip file.

-

Methods

close

  • close(): Promise<void>

  • Closes the zip file

    -

    Returns Promise<void>

getEntries

  • getEntries(options?): Promise<Entry[]>

  • Returns all the entries in the zip file

    +

Returns ZipReader<Type>

Properties

Optional appendedData

appendedData?: Uint8Array

The data appended after the zip file.

+

comment

comment: Uint8Array

The global comment of the zip file.

+

Optional prependedData

prependedData?: Uint8Array

The data prepended before the zip file.

+

Methods

close

getEntries

getEntriesGenerator

getEntriesGenerator

Settings

Member Visibility

Theme

On This Page

constructorappendedDatacommentprependedDataclosegetEntriesgetEntriesGenerator
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorappendedDatacommentprependedDataclosegetEntriesgetEntriesGenerator
\ No newline at end of file diff --git a/api/classes/ZipReaderStream.html b/api/classes/ZipReaderStream.html index 17e677f1..69ec3397 100644 --- a/api/classes/ZipReaderStream.html +++ b/api/classes/ZipReaderStream.html @@ -1,12 +1,12 @@ ZipReaderStream | @zip.js/zip.js

Class ZipReaderStream<T>

Represents an instance used to create an unzipped stream.

-

Example

This example will take a zip file, decompress it and then recompress each file in it, saving it to disk.

-
for await (const entry of (await fetch(urlToZippedFile)).body.pipeThrough(new ZipWriterStream()))
  if (entry.readable) {
    console.log(entry.filename)
    entry.readable
      .pipeThrough(ZipReaderStream().transform(entry.filename))
      .pipeTo((await Deno.create(entry.filename + '.zip')).writable)
  }
+

Example

This example will take a zip file, decompress it and then save its files and directories to disk.

+
import {resolve} from "https://deno.land/std/path/mod.ts";
import {ensureDir, ensureFile} from "https://deno.land/std/fs/mod.ts";

for await (const entry of (await fetch(urlToZippedFile)).body.pipeThrough(new ZipReaderStream())) {
  const fullPath = resolve(destination, entry.filename);
  if (entry.directory) {
    await ensureDir(fullPath);
    continue;
  }

  await ensureFile(fullPath);
  await entry.readable?.pipeTo((await Deno.create(fullPath)).writable);
}
-

Type Parameters

  • T

Constructors

constructor +

Type Parameters

  • T

Constructors

constructor

Properties

readable writable

Constructors

constructor

Properties

readable

readable: ReadableStream<Omit<Entry, "getData"> & {
    readable?: ReadableStream<Uint8Array>;
}>

The readable stream.

-

writable

writable: WritableStream<T>

The writable stream.

-

Settings

Member Visibility

Theme

On This Page

constructorreadablewritable
\ No newline at end of file +

Returns ZipReaderStream<T>

Properties

readable

readable: ReadableStream<Omit<Entry, "getData"> & {
    readable?: ReadableStream<Uint8Array>;
}>

The readable stream.

+

writable

writable: WritableStream<T>

The writable stream.

+

Settings

Member Visibility

Theme

On This Page

constructorreadablewritable
\ No newline at end of file diff --git a/api/classes/ZipWriter.html b/api/classes/ZipWriter.html index 05737709..91910ecd 100644 --- a/api/classes/ZipWriter.html +++ b/api/classes/ZipWriter.html @@ -2,21 +2,21 @@

Example

Here is an example showing how to create a zip file containing a compressed text file:

// use a BlobWriter to store with a ZipWriter the zip into a Blob object
const blobWriter = new zip.BlobWriter("application/zip");
const writer = new zip.ZipWriter(blobWriter);

// use a TextReader to read the String to add
await writer.add("filename.txt", new zip.TextReader("test!"));

// close the ZipReader
await writer.close();

// get the zip file as a Blob
const blob = await blobWriter.getData();
-

Type Parameters

Constructors

constructor +

Type Parameters

  • Type

Constructors

constructor

Properties

hasCorruptedEntries?

Methods

add close

Constructors

constructor

Properties

Optional Readonly hasCorruptedEntries

hasCorruptedEntries?: boolean

true if the zip contains at least one entry that has been partially written.

-

Methods

add

Returns ZipWriter<Type>

Properties

Optional Readonly hasCorruptedEntries

hasCorruptedEntries?: boolean

true if the zip contains at least one entry that has been partially written.

+

Methods

add

close

  • close(comment?, options?): Promise<Type>

  • Writes the entries directory, writes the global comment, and returns the content of the zip file

    +

close

  • close(comment?, options?): Promise<Type>

  • Writes the entries directory, writes the global comment, and returns the content of the zip file

    Parameters

    • Optional comment: Uint8Array

      The global comment of the zip file.

    • Optional options: ZipWriterCloseOptions

      The options.

    Returns Promise<Type>

    The content of the zip file.

    -

Settings

Member Visibility

Theme

On This Page

constructorhasCorruptedEntriesaddclose
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorhasCorruptedEntriesaddclose
\ No newline at end of file diff --git a/api/classes/ZipWriterStream.html b/api/classes/ZipWriterStream.html index fde97a6f..d87b7bcd 100644 --- a/api/classes/ZipWriterStream.html +++ b/api/classes/ZipWriterStream.html @@ -5,7 +5,7 @@

Example

This example creates a zipped file called Archive.zip containing two files called numbers.txt and letters.txt

const readable1 = ReadableStream.from((function* () {
  for (let i = 0; i < 1000; ++i)
    yield i + '\n'
})())
const readable2 = ReadableStream.from((function* () {
  const letters = 'abcdefghijklmnopqrstuvwxyz'.split('')
  while (letters.length)
    yield letters.shift() + '\n'
})())

const zipper = new ZipWriterStream()
zipper.readable.pipeTo((await Deno.create('Archive.zip')).writable)
readable1.pipeTo(zipper.writable('numbers.txt'))
readable2.pipeTo(zipper.writable('letters.txt'))
zipper.close()
-

Constructors

constructor +

Constructors

constructor

Properties

readable zipWriter

Methods

close @@ -13,16 +13,16 @@

Example

This example creates a zipped file called Archive.zip contain writable

Constructors

constructor

Properties

readable

readable: ReadableStream<Uint8Array>

The readable stream.

-

zipWriter

zipWriter: ZipWriter<unknown>

The ZipWriter property.

-

Methods

close

  • close(comment?, options?): Promise<unknown>

  • Writes the entries directory, writes the global comment, and returns the content of the zipped file.

    +

Returns ZipWriterStream

Properties

readable

readable: ReadableStream<Uint8Array>

The readable stream.

+

zipWriter

zipWriter: ZipWriter<unknown>

The ZipWriter property.

+

Methods

close

  • close(comment?, options?): Promise<unknown>

  • Writes the entries directory, writes the global comment, and returns the content of the zipped file.

    Parameters

    • Optional comment: Uint8Array

      The global comment of the zip file.

    • Optional options: ZipWriterCloseOptions

      The options.

    Returns Promise<unknown>

    The content of the zip file.

    -

transform

  • transform<T>(path): {
        readable: ReadableStream<T>;
        writable: WritableStream<T>;
    }

  • Returns an object containing a readable and writable property for the .pipeThrough method

    +

transform

  • transform<T>(path): {
        readable: ReadableStream<T>;
        writable: WritableStream<T>;
    }

  • Returns an object containing a readable and writable property for the .pipeThrough method

    Type Parameters

    • T

    Parameters

    • path: string

      The name of the stream when unzipped.

    Returns {
        readable: ReadableStream<T>;
        writable: WritableStream<T>;
    }

    An object containing readable and writable properties

    -
    • readable: ReadableStream<T>
    • writable: WritableStream<T>

writable

  • writable<T>(path): WritableStream<T>

  • Returns a WritableStream for the .pipeTo method

    +
    • readable: ReadableStream<T>
    • writable: WritableStream<T>

writable

  • writable<T>(path): WritableStream<T>

  • Returns a WritableStream for the .pipeTo method

    Type Parameters

    • T

    Parameters

    • path: string

      The directory path of where the stream should exist in the zipped stream.

    Returns WritableStream<T>

    A WritableStream.

    -

Settings

Member Visibility

Theme

On This Page

constructorreadablezipWriterclosetransformwritable
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructorreadablezipWriterclosetransformwritable
\ No newline at end of file diff --git a/api/functions/configure.html b/api/functions/configure.html index dd6dd5fb..5c5ba8af 100644 --- a/api/functions/configure.html +++ b/api/functions/configure.html @@ -1,3 +1,3 @@ configure | @zip.js/zip.js

Function configure

  • configure(configuration): void

  • Configures zip.js

    Parameters

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/api/functions/getMimeType.html b/api/functions/getMimeType.html index b381b04f..b9c2560d 100644 --- a/api/functions/getMimeType.html +++ b/api/functions/getMimeType.html @@ -1,4 +1,4 @@ getMimeType | @zip.js/zip.js

Function getMimeType

  • getMimeType(fileExtension): string

  • Returns the MIME type corresponding to a filename extension.

    Parameters

    • fileExtension: string

      the extension of the filename.

    Returns string

    The corresponding MIME type.

    -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/api/functions/initShimAsyncCodec.html b/api/functions/initShimAsyncCodec.html index 58c7064a..e6c1e498 100644 --- a/api/functions/initShimAsyncCodec.html +++ b/api/functions/initShimAsyncCodec.html @@ -3,4 +3,4 @@
  • constructorOptions: unknown

    The options passed to the third-party implementations when building instances.

  • registerDataHandler: registerDataHandler

    The function called to handle the data events triggered by a third-party codec implementation.

    • Returns ZipLibrary

    An instance containing classes compatible with ZipDeflate and ZipInflate.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/functions/terminateWorkers.html b/api/functions/terminateWorkers.html index 54721fd9..215e4a8c 100644 --- a/api/functions/terminateWorkers.html +++ b/api/functions/terminateWorkers.html @@ -1,2 +1,2 @@ terminateWorkers | @zip.js/zip.js

    Function terminateWorkers

    • terminateWorkers(): Promise<void>

    • Terminates all the web workers

      -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/interfaces/Configuration.html b/api/interfaces/Configuration.html index 8a0b5930..80f992a8 100644 --- a/api/interfaces/Configuration.html +++ b/api/interfaces/Configuration.html @@ -1,5 +1,5 @@ Configuration | @zip.js/zip.js

    Interface Configuration

    Represents the configuration passed to configure.

    -
    interface Configuration {
        CompressionStream?: typeof TransformStreamLike;
        DecompressionStream?: typeof TransformStreamLike;
        Deflate?: typeof ZipDeflate;
        Inflate?: typeof ZipInflate;
        chunkSize?: number;
        maxWorkers?: number;
        terminateWorkerTimeout?: number;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        workerScripts?: {
            deflate?: string[];
            inflate?: string[];
        };
    }

    Hierarchy (view full)

    Properties

    CompressionStream? +
    interface Configuration {
        CompressionStream?: typeof TransformStreamLike;
        DecompressionStream?: typeof TransformStreamLike;
        Deflate?: typeof ZipDeflate;
        Inflate?: typeof ZipInflate;
        chunkSize?: number;
        maxWorkers?: number;
        terminateWorkerTimeout?: number;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        workerScripts?: {
            deflate?: string[];
            inflate?: string[];
        };
    }

    Hierarchy (view full)

    Properties

    CompressionStream? DecompressionStream? Deflate? Inflate? @@ -12,30 +12,30 @@

    Properties

    Optional CompressionStream

    CompressionStream?: typeof TransformStreamLike

    The stream implementation used to compress data when useCompressionStream is set to false.

    Default Value

    {@link CodecStream}
    -

    Optional DecompressionStream

    DecompressionStream?: typeof TransformStreamLike

    The stream implementation used to decompress data when useCompressionStream is set to false.

    +

    Optional DecompressionStream

    DecompressionStream?: typeof TransformStreamLike

    The stream implementation used to decompress data when useCompressionStream is set to false.

    Default Value

    {@link CodecStream}
    -

    Optional Deflate

    Deflate?: typeof ZipDeflate

    The codec implementation used to compress data.

    +

    Optional Deflate

    Deflate?: typeof ZipDeflate

    The codec implementation used to compress data.

    Default Value

    {@link ZipDeflate}
    -

    Optional Inflate

    Inflate?: typeof ZipInflate

    The codec implementation used to decompress data.

    +

    Optional Inflate

    Inflate?: typeof ZipInflate

    The codec implementation used to decompress data.

    Default Value

    {@link ZipInflate}
    -

    Optional chunkSize

    chunkSize?: number

    The size of the chunks in bytes during data compression/decompression.

    +

    Optional chunkSize

    chunkSize?: number

    The size of the chunks in bytes during data compression/decompression.

    Default Value

    524288
    -

    Optional maxWorkers

    maxWorkers?: number

    The maximum number of web workers used to compress/decompress data simultaneously.

    +

    Optional maxWorkers

    maxWorkers?: number

    The maximum number of web workers used to compress/decompress data simultaneously.

    Default Value

    navigator.hardwareConcurrency

    -

    Optional terminateWorkerTimeout

    terminateWorkerTimeout?: number

    The delay in milliseconds before idle web workers are automatically terminated. You can call terminateWorkers() to terminate idle workers.

    +

    Optional terminateWorkerTimeout

    terminateWorkerTimeout?: number

    The delay in milliseconds before idle web workers are automatically terminated. You can call terminateWorkers() to terminate idle workers.

    Default Value

    5000
    -

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    +

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    Default Value

    true
    -

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    +

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    Default Value

    true
    -

    Optional workerScripts

    workerScripts?: {
        deflate?: string[];
        inflate?: string[];
    }

    The URIs of the compression/decompression scripts run in web workers.

    +

    Optional workerScripts

    workerScripts?: {
        deflate?: string[];
        inflate?: string[];
    }

    The URIs of the compression/decompression scripts run in web workers.

    It allows using alternative deflate implementations or specifying a URL to the worker script if the CSP of the page blocks scripts imported from a Blob URI. The properties deflate and inflate must specify arrays of URLs to import the deflate/inflate web workers, respectively. The first URL is relative to the base URI of the document. The other URLs are relative to the URL of the first script. Scripts in the array are executed in order. @@ -49,4 +49,4 @@

    Type declaration

    • Optional deflate?: string[]

      The URIs of the scripts implementing used for compression.

    • Optional inflate?: string[]

      The URIs of the scripts implementing used for decompression.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    CompressionStreamDecompressionStreamDeflateInflatechunkSizemaxWorkersterminateWorkerTimeoutuseCompressionStreamuseWebWorkersworkerScripts
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    CompressionStreamDecompressionStreamDeflateInflatechunkSizemaxWorkersterminateWorkerTimeoutuseCompressionStreamuseWebWorkersworkerScripts
    \ No newline at end of file diff --git a/api/interfaces/Entry.html b/api/interfaces/Entry.html index cf5cecd0..61a13920 100644 --- a/api/interfaces/Entry.html +++ b/api/interfaces/Entry.html @@ -1,5 +1,5 @@ Entry | @zip.js/zip.js

    Interface Entry

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

    -
    interface Entry {
        comment: string;
        commentUTF8: boolean;
        compressedSize: number;
        creationDate?: Date;
        directory: boolean;
        diskNumberStart: number;
        encrypted: boolean;
        externalFileAttribute: number;
        extraField?: Map<number, Uint8Array>;
        filename: string;
        filenameUTF8: boolean;
        internalFileAttribute: number;
        lastAccessDate?: Date;
        lastModDate: Date;
        msDosCompatible: boolean;
        offset: number;
        rawComment: Uint8Array;
        rawCreationDate?: number | bigint;
        rawExtraField: Uint8Array;
        rawFilename: Uint8Array;
        rawLastAccessDate?: number | bigint;
        rawLastModDate: number | bigint;
        signature: number;
        uncompressedSize: number;
        version: number;
        versionMadeBy: number;
        zip64: boolean;
        getData?<Type>(writer, options?): Promise<Type>;
        getData?(writer, options): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    comment +
    interface Entry {
        comment: string;
        commentUTF8: boolean;
        compressedSize: number;
        creationDate?: Date;
        directory: boolean;
        diskNumberStart: number;
        encrypted: boolean;
        externalFileAttribute: number;
        extraField?: Map<number, Uint8Array>;
        filename: string;
        filenameUTF8: boolean;
        internalFileAttribute: number;
        lastAccessDate?: Date;
        lastModDate: Date;
        msDosCompatible: boolean;
        offset: number;
        rawComment: Uint8Array;
        rawCreationDate?: number | bigint;
        rawExtraField: Uint8Array;
        rawFilename: Uint8Array;
        rawLastAccessDate?: number | bigint;
        rawLastModDate: number | bigint;
        signature: number;
        uncompressedSize: number;
        version: number;
        versionMadeBy: number;
        zip64: boolean;
        getData?<Type>(writer, options?): Promise<Type>;
        getData?(writer, options): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    comment commentUTF8 compressedSize creationDate? @@ -28,37 +28,37 @@ zip64

    Methods

    getData?

    Properties

    comment

    comment: string

    The comment of the entry.

    -

    commentUTF8

    commentUTF8: boolean

    true if the comment is encoded in UTF-8.

    -

    compressedSize

    compressedSize: number

    The size of the compressed data in bytes.

    -

    Optional creationDate

    creationDate?: Date

    The creation date.

    -

    directory

    directory: boolean

    true if the entry is a directory.

    -

    diskNumberStart

    diskNumberStart: number

    The number of the disk where the entry data starts.

    -

    encrypted

    encrypted: boolean

    true if the content of the entry is encrypted.

    -

    externalFileAttribute

    externalFileAttribute: number

    The external file attribute (raw).

    -

    Optional extraField

    extraField?: Map<number, Uint8Array>

    The extra field.

    -

    filename

    filename: string

    The filename of the entry.

    -

    filenameUTF8

    filenameUTF8: boolean

    true if the filename is encoded in UTF-8.

    -

    internalFileAttribute

    internalFileAttribute: number

    The internal file attribute (raw).

    -

    Optional lastAccessDate

    lastAccessDate?: Date

    The last access date.

    -

    lastModDate

    lastModDate: Date

    The last modification date.

    -

    msDosCompatible

    msDosCompatible: boolean

    true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.

    -

    offset

    offset: number

    The byte offset of the entry.

    -

    rawComment

    rawComment: Uint8Array

    The comment of the entry (raw).

    -

    Optional rawCreationDate

    rawCreationDate?: number | bigint

    The creation date (raw).

    -

    rawExtraField

    rawExtraField: Uint8Array

    The extra field (raw).

    -

    rawFilename

    rawFilename: Uint8Array

    The filename of the entry (raw).

    -

    Optional rawLastAccessDate

    rawLastAccessDate?: number | bigint

    The last access date (raw).

    -

    rawLastModDate

    rawLastModDate: number | bigint

    The last modification date (raw).

    -

    signature

    signature: number

    The signature (CRC32 checksum) of the content.

    -

    uncompressedSize

    uncompressedSize: number

    The size of the decompressed data in bytes.

    -

    version

    version: number

    The "Version" field.

    -

    versionMadeBy

    versionMadeBy: number

    The "Version made by" field.

    -

    zip64

    zip64: boolean

    true if the entry is using Zip64.

    -

    Methods

    Optional getData

    commentUTF8

    commentUTF8: boolean

    true if the comment is encoded in UTF-8.

    +

    compressedSize

    compressedSize: number

    The size of the compressed data in bytes.

    +

    Optional creationDate

    creationDate?: Date

    The creation date.

    +

    directory

    directory: boolean

    true if the entry is a directory.

    +

    diskNumberStart

    diskNumberStart: number

    The number of the disk where the entry data starts.

    +

    encrypted

    encrypted: boolean

    true if the content of the entry is encrypted.

    +

    externalFileAttribute

    externalFileAttribute: number

    The external file attribute (raw).

    +

    Optional extraField

    extraField?: Map<number, Uint8Array>

    The extra field.

    +

    filename

    filename: string

    The filename of the entry.

    +

    filenameUTF8

    filenameUTF8: boolean

    true if the filename is encoded in UTF-8.

    +

    internalFileAttribute

    internalFileAttribute: number

    The internal file attribute (raw).

    +

    Optional lastAccessDate

    lastAccessDate?: Date

    The last access date.

    +

    lastModDate

    lastModDate: Date

    The last modification date.

    +

    msDosCompatible

    msDosCompatible: boolean

    true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.

    +

    offset

    offset: number

    The byte offset of the entry.

    +

    rawComment

    rawComment: Uint8Array

    The comment of the entry (raw).

    +

    Optional rawCreationDate

    rawCreationDate?: number | bigint

    The creation date (raw).

    +

    rawExtraField

    rawExtraField: Uint8Array

    The extra field (raw).

    +

    rawFilename

    rawFilename: Uint8Array

    The filename of the entry (raw).

    +

    Optional rawLastAccessDate

    rawLastAccessDate?: number | bigint

    The last access date (raw).

    +

    rawLastModDate

    rawLastModDate: number | bigint

    The last modification date (raw).

    +

    signature

    signature: number

    The signature (CRC32 checksum) of the content.

    +

    uncompressedSize

    uncompressedSize: number

    The size of the decompressed data in bytes.

    +

    version

    version: number

    The "Version" field.

    +

    versionMadeBy

    versionMadeBy: number

    The "Version made by" field.

    +

    zip64

    zip64: boolean

    true if the entry is using Zip64.

    +

    Methods

    Optional getData

    • getData<Type>(writer, options?): Promise<Type>

    • Returns the content of the entry

      Type Parameters

      • Type

      Parameters

      Returns Promise<Type>

      A promise resolving to the type to data associated to writer.

      -
    • getData(writer, options): Promise<void>

    • Tests if the password is valid.

      +
    • getData(writer, options): Promise<void>

    • Tests if the password is valid.

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    commentcommentUTF8compressedSizecreationDatedirectorydiskNumberStartencryptedexternalFileAttributeextraFieldfilenamefilenameUTF8internalFileAttributelastAccessDatelastModDatemsDosCompatibleoffsetrawCommentrawCreationDaterawExtraFieldrawFilenamerawLastAccessDaterawLastModDatesignatureuncompressedSizeversionversionMadeByzip64getData
    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    commentcommentUTF8compressedSizecreationDatedirectorydiskNumberStartencryptedexternalFileAttributeextraFieldfilenamefilenameUTF8internalFileAttributelastAccessDatelastModDatemsDosCompatibleoffsetrawCommentrawCreationDaterawExtraFieldrawFilenamerawLastAccessDaterawLastModDatesignatureuncompressedSizeversionversionMadeByzip64getData
    \ No newline at end of file diff --git a/api/interfaces/EntryDataOnprogressOptions.html b/api/interfaces/EntryDataOnprogressOptions.html index 1a6547a4..7882e80f 100644 --- a/api/interfaces/EntryDataOnprogressOptions.html +++ b/api/interfaces/EntryDataOnprogressOptions.html @@ -1,15 +1,15 @@ EntryDataOnprogressOptions | @zip.js/zip.js

    Interface EntryDataOnprogressOptions

    Represents options passed to Entry#getData, ZipWriter.add and {@link ZipDirectory}.export*.

    -
    interface EntryDataOnprogressOptions {
        onend?(computedSize): Promise<void>;
        onprogress?(progress, total): Promise<void>;
        onstart?(total): Promise<void>;
    }

    Hierarchy (view full)

    Methods

    onend? +
    interface EntryDataOnprogressOptions {
        onend?(computedSize): Promise<void>;
        onprogress?(progress, total): Promise<void>;
        onstart?(total): Promise<void>;
    }

    Hierarchy (view full)

    Methods

    onend? onprogress? onstart?

    Methods

    Optional onend

    • onend(computedSize): Promise<void>

    • The function called when ending compression/decompression.

      Parameters

      • computedSize: number

        The total number of bytes (computed).

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optional onprogress

    • onprogress(progress, total): Promise<void>

    • The function called during compression/decompression.

      +

    Optional onprogress

    • onprogress(progress, total): Promise<void>

    • The function called during compression/decompression.

      Parameters

      • progress: number

        The current progress in bytes.

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optional onstart

    • onstart(total): Promise<void>

    • The function called when starting compression/decompression.

      +

    Optional onstart

    • onstart(total): Promise<void>

    • The function called when starting compression/decompression.

      Parameters

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    onendonprogressonstart
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    onendonprogressonstart
    \ No newline at end of file diff --git a/api/interfaces/EntryGetDataCheckPasswordOptions.html b/api/interfaces/EntryGetDataCheckPasswordOptions.html index 6b2b234e..484a7109 100644 --- a/api/interfaces/EntryGetDataCheckPasswordOptions.html +++ b/api/interfaces/EntryGetDataCheckPasswordOptions.html @@ -1,5 +1,5 @@ EntryGetDataCheckPasswordOptions | @zip.js/zip.js

    Interface EntryGetDataCheckPasswordOptions

    Represents the options passed to Entry#getData and {@link ZipFileEntry}.get*.

    -
    interface EntryGetDataCheckPasswordOptions {
        checkPasswordOnly: boolean;
        checkSignature?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        onend?(computedSize): Promise<void>;
        onprogress?(progress, total): Promise<void>;
        onstart?(total): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    checkPasswordOnly +
    interface EntryGetDataCheckPasswordOptions {
        checkPasswordOnly: boolean;
        checkSignature?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        onend?(computedSize): Promise<void>;
        onprogress?(progress, total): Promise<void>;
        onstart?(total): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    checkPasswordOnly checkSignature? password? preventClose? @@ -14,32 +14,32 @@

    Properties

    checkPasswordOnly

    checkPasswordOnly: boolean

    true to check only if the password is valid.

    Default Value

    false
    -

    Optional checkSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    +

    Optional checkSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    Default Value

    false
    -

    Optional password

    password?: string

    The password used to decrypt the content of the entry.

    -

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    +

    Optional password

    password?: string

    The password used to decrypt the content of the entry.

    +

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    Default Value

    false
    -

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    -

    Optional transferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    +

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    +

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    +

    Optional transferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    Default Value

    true
    -

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    +

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    Default Value

    true
    -

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    +

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    Default Value

    true
    -

    Methods

    Optional onend

    Methods

    Optional onend

    • onend(computedSize): Promise<void>

    • The function called when ending compression/decompression.

      Parameters

      • computedSize: number

        The total number of bytes (computed).

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optional onprogress

    Optional onprogress

    • onprogress(progress, total): Promise<void>

    • The function called during compression/decompression.

      Parameters

      • progress: number

        The current progress in bytes.

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optional onstart

    Optional onstart

    • onstart(total): Promise<void>

    • The function called when starting compression/decompression.

      Parameters

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    checkPasswordOnlycheckSignaturepasswordpreventCloserawPasswordsignaltransferStreamsuseCompressionStreamuseWebWorkersonendonprogressonstart
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    checkPasswordOnlycheckSignaturepasswordpreventCloserawPasswordsignaltransferStreamsuseCompressionStreamuseWebWorkersonendonprogressonstart
    \ No newline at end of file diff --git a/api/interfaces/EntryGetDataOptions.html b/api/interfaces/EntryGetDataOptions.html index a95987a9..0306115e 100644 --- a/api/interfaces/EntryGetDataOptions.html +++ b/api/interfaces/EntryGetDataOptions.html @@ -1,5 +1,5 @@ EntryGetDataOptions | @zip.js/zip.js

    Interface EntryGetDataOptions

    Represents the options passed to Entry#getData and {@link ZipFileEntry}.get*.

    -
    interface EntryGetDataOptions {
        checkSignature?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        onend?(computedSize): Promise<void>;
        onprogress?(progress, total): Promise<void>;
        onstart?(total): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    checkSignature? +
    interface EntryGetDataOptions {
        checkSignature?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        onend?(computedSize): Promise<void>;
        onprogress?(progress, total): Promise<void>;
        onstart?(total): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    checkSignature? password? preventClose? rawPassword? @@ -13,29 +13,29 @@

    Properties

    Optional checkSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    Default Value

    false
    -

    Optional password

    password?: string

    The password used to decrypt the content of the entry.

    -

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    +

    Optional password

    password?: string

    The password used to decrypt the content of the entry.

    +

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    Default Value

    false
    -

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    -

    Optional transferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    +

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    +

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    +

    Optional transferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    Default Value

    true
    -

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    +

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    Default Value

    true
    -

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    +

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    Default Value

    true
    -

    Methods

    Optional onend

    Methods

    Optional onend

    • onend(computedSize): Promise<void>

    • The function called when ending compression/decompression.

      Parameters

      • computedSize: number

        The total number of bytes (computed).

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optional onprogress

    Optional onprogress

    • onprogress(progress, total): Promise<void>

    • The function called during compression/decompression.

      Parameters

      • progress: number

        The current progress in bytes.

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optional onstart

    Optional onstart

    • onstart(total): Promise<void>

    • The function called when starting compression/decompression.

      Parameters

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    checkSignaturepasswordpreventCloserawPasswordsignaltransferStreamsuseCompressionStreamuseWebWorkersonendonprogressonstart
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    checkSignaturepasswordpreventCloserawPasswordsignaltransferStreamsuseCompressionStreamuseWebWorkersonendonprogressonstart
    \ No newline at end of file diff --git a/api/interfaces/EntryMetaData.html b/api/interfaces/EntryMetaData.html index 4fdf31b9..9882db95 100644 --- a/api/interfaces/EntryMetaData.html +++ b/api/interfaces/EntryMetaData.html @@ -1,5 +1,5 @@ EntryMetaData | @zip.js/zip.js

    Interface EntryMetaData

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

    -
    interface EntryMetaData {
        comment: string;
        commentUTF8: boolean;
        compressedSize: number;
        creationDate?: Date;
        directory: boolean;
        diskNumberStart: number;
        encrypted: boolean;
        externalFileAttribute: number;
        extraField?: Map<number, Uint8Array>;
        filename: string;
        filenameUTF8: boolean;
        internalFileAttribute: number;
        lastAccessDate?: Date;
        lastModDate: Date;
        msDosCompatible: boolean;
        offset: number;
        rawComment: Uint8Array;
        rawCreationDate?: number | bigint;
        rawExtraField: Uint8Array;
        rawFilename: Uint8Array;
        rawLastAccessDate?: number | bigint;
        rawLastModDate: number | bigint;
        signature: number;
        uncompressedSize: number;
        version: number;
        versionMadeBy: number;
        zip64: boolean;
    }

    Hierarchy (view full)

    Properties

    comment +
    interface EntryMetaData {
        comment: string;
        commentUTF8: boolean;
        compressedSize: number;
        creationDate?: Date;
        directory: boolean;
        diskNumberStart: number;
        encrypted: boolean;
        externalFileAttribute: number;
        extraField?: Map<number, Uint8Array>;
        filename: string;
        filenameUTF8: boolean;
        internalFileAttribute: number;
        lastAccessDate?: Date;
        lastModDate: Date;
        msDosCompatible: boolean;
        offset: number;
        rawComment: Uint8Array;
        rawCreationDate?: number | bigint;
        rawExtraField: Uint8Array;
        rawFilename: Uint8Array;
        rawLastAccessDate?: number | bigint;
        rawLastModDate: number | bigint;
        signature: number;
        uncompressedSize: number;
        version: number;
        versionMadeBy: number;
        zip64: boolean;
    }

    Hierarchy (view full)

    Properties

    comment commentUTF8 compressedSize creationDate? @@ -27,30 +27,30 @@ versionMadeBy zip64

    Properties

    comment

    comment: string

    The comment of the entry.

    -

    commentUTF8

    commentUTF8: boolean

    true if the comment is encoded in UTF-8.

    -

    compressedSize

    compressedSize: number

    The size of the compressed data in bytes.

    -

    Optional creationDate

    creationDate?: Date

    The creation date.

    -

    directory

    directory: boolean

    true if the entry is a directory.

    -

    diskNumberStart

    diskNumberStart: number

    The number of the disk where the entry data starts.

    -

    encrypted

    encrypted: boolean

    true if the content of the entry is encrypted.

    -

    externalFileAttribute

    externalFileAttribute: number

    The external file attribute (raw).

    -

    Optional extraField

    extraField?: Map<number, Uint8Array>

    The extra field.

    -

    filename

    filename: string

    The filename of the entry.

    -

    filenameUTF8

    filenameUTF8: boolean

    true if the filename is encoded in UTF-8.

    -

    internalFileAttribute

    internalFileAttribute: number

    The internal file attribute (raw).

    -

    Optional lastAccessDate

    lastAccessDate?: Date

    The last access date.

    -

    lastModDate

    lastModDate: Date

    The last modification date.

    -

    msDosCompatible

    msDosCompatible: boolean

    true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.

    -

    offset

    offset: number

    The byte offset of the entry.

    -

    rawComment

    rawComment: Uint8Array

    The comment of the entry (raw).

    -

    Optional rawCreationDate

    rawCreationDate?: number | bigint

    The creation date (raw).

    -

    rawExtraField

    rawExtraField: Uint8Array

    The extra field (raw).

    -

    rawFilename

    rawFilename: Uint8Array

    The filename of the entry (raw).

    -

    Optional rawLastAccessDate

    rawLastAccessDate?: number | bigint

    The last access date (raw).

    -

    rawLastModDate

    rawLastModDate: number | bigint

    The last modification date (raw).

    -

    signature

    signature: number

    The signature (CRC32 checksum) of the content.

    -

    uncompressedSize

    uncompressedSize: number

    The size of the decompressed data in bytes.

    -

    version

    version: number

    The "Version" field.

    -

    versionMadeBy

    versionMadeBy: number

    The "Version made by" field.

    -

    zip64

    zip64: boolean

    true if the entry is using Zip64.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    commentcommentUTF8compressedSizecreationDatedirectorydiskNumberStartencryptedexternalFileAttributeextraFieldfilenamefilenameUTF8internalFileAttributelastAccessDatelastModDatemsDosCompatibleoffsetrawCommentrawCreationDaterawExtraFieldrawFilenamerawLastAccessDaterawLastModDatesignatureuncompressedSizeversionversionMadeByzip64
    \ No newline at end of file +

    commentUTF8

    commentUTF8: boolean

    true if the comment is encoded in UTF-8.

    +

    compressedSize

    compressedSize: number

    The size of the compressed data in bytes.

    +

    Optional creationDate

    creationDate?: Date

    The creation date.

    +

    directory

    directory: boolean

    true if the entry is a directory.

    +

    diskNumberStart

    diskNumberStart: number

    The number of the disk where the entry data starts.

    +

    encrypted

    encrypted: boolean

    true if the content of the entry is encrypted.

    +

    externalFileAttribute

    externalFileAttribute: number

    The external file attribute (raw).

    +

    Optional extraField

    extraField?: Map<number, Uint8Array>

    The extra field.

    +

    filename

    filename: string

    The filename of the entry.

    +

    filenameUTF8

    filenameUTF8: boolean

    true if the filename is encoded in UTF-8.

    +

    internalFileAttribute

    internalFileAttribute: number

    The internal file attribute (raw).

    +

    Optional lastAccessDate

    lastAccessDate?: Date

    The last access date.

    +

    lastModDate

    lastModDate: Date

    The last modification date.

    +

    msDosCompatible

    msDosCompatible: boolean

    true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.

    +

    offset

    offset: number

    The byte offset of the entry.

    +

    rawComment

    rawComment: Uint8Array

    The comment of the entry (raw).

    +

    Optional rawCreationDate

    rawCreationDate?: number | bigint

    The creation date (raw).

    +

    rawExtraField

    rawExtraField: Uint8Array

    The extra field (raw).

    +

    rawFilename

    rawFilename: Uint8Array

    The filename of the entry (raw).

    +

    Optional rawLastAccessDate

    rawLastAccessDate?: number | bigint

    The last access date (raw).

    +

    rawLastModDate

    rawLastModDate: number | bigint

    The last modification date (raw).

    +

    signature

    signature: number

    The signature (CRC32 checksum) of the content.

    +

    uncompressedSize

    uncompressedSize: number

    The size of the decompressed data in bytes.

    +

    version

    version: number

    The "Version" field.

    +

    versionMadeBy

    versionMadeBy: number

    The "Version made by" field.

    +

    zip64

    zip64: boolean

    true if the entry is using Zip64.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    commentcommentUTF8compressedSizecreationDatedirectorydiskNumberStartencryptedexternalFileAttributeextraFieldfilenamefilenameUTF8internalFileAttributelastAccessDatelastModDatemsDosCompatibleoffsetrawCommentrawCreationDaterawExtraFieldrawFilenamerawLastAccessDaterawLastModDatesignatureuncompressedSizeversionversionMadeByzip64
    \ No newline at end of file diff --git a/api/interfaces/EntryOnprogressOptions.html b/api/interfaces/EntryOnprogressOptions.html index b1371329..5e3a14f6 100644 --- a/api/interfaces/EntryOnprogressOptions.html +++ b/api/interfaces/EntryOnprogressOptions.html @@ -1,8 +1,8 @@ EntryOnprogressOptions | @zip.js/zip.js

    Interface EntryOnprogressOptions

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

    -
    interface EntryOnprogressOptions {
        onprogress?(progress, total, entry): Promise<void>;
    }

    Hierarchy (view full)

    Methods

    onprogress? +
    interface EntryOnprogressOptions {
        onprogress?(progress, total, entry): Promise<void>;
    }

    Hierarchy (view full)

    Methods

    onprogress?

    Methods

    Optional onprogress

    • onprogress(progress, total, entry): Promise<void>

    • The function called each time an entry is read/written.

      Parameters

      • progress: number

        The entry index.

      • total: number

        The total number of entries.

      • entry: EntryMetaData

        The entry being read/written.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    onprogress
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    onprogress
    \ No newline at end of file diff --git a/api/interfaces/EventBasedZipLibrary.html b/api/interfaces/EventBasedZipLibrary.html index 147397d7..e5e3a547 100644 --- a/api/interfaces/EventBasedZipLibrary.html +++ b/api/interfaces/EventBasedZipLibrary.html @@ -1,6 +1,6 @@ EventBasedZipLibrary | @zip.js/zip.js

    Interface EventBasedZipLibrary

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

    -
    interface EventBasedZipLibrary {
        Deflate: typeof EventBasedCodec;
        Inflate: typeof EventBasedCodec;
    }

    Properties

    Deflate +
    interface EventBasedZipLibrary {
        Deflate: typeof EventBasedCodec;
        Inflate: typeof EventBasedCodec;
    }

    Properties

    Deflate Inflate

    Properties

    Deflate

    Deflate: typeof EventBasedCodec

    The class used to compress data.

    -

    Inflate

    Inflate: typeof EventBasedCodec

    The class used to decompress data.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    DeflateInflate
    \ No newline at end of file +

    Inflate

    Inflate: typeof EventBasedCodec

    The class used to decompress data.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    DeflateInflate
    \ No newline at end of file diff --git a/api/interfaces/FileSystemEntryLike.html b/api/interfaces/FileSystemEntryLike.html index 8af77392..f6860fd8 100644 --- a/api/interfaces/FileSystemEntryLike.html +++ b/api/interfaces/FileSystemEntryLike.html @@ -1,3 +1,3 @@ FileSystemEntryLike | @zip.js/zip.js

    Interface FileSystemEntryLike

    Represents the FileSystemEntry class.

    See

    https://wicg.github.io/entries-api/#api-entry|specification

    -
    interface FileSystemEntryLike {}

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
    interface FileSystemEntryLike {}

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/interfaces/FileSystemHandleLike.html b/api/interfaces/FileSystemHandleLike.html index 30ba1710..a9f9515b 100644 --- a/api/interfaces/FileSystemHandleLike.html +++ b/api/interfaces/FileSystemHandleLike.html @@ -1,3 +1,3 @@ FileSystemHandleLike | @zip.js/zip.js

    Interface FileSystemHandleLike

    Represents the FileSystemHandle class.

    See

    https://fs.spec.whatwg.org/#api-filesystemhandle

    -
    interface FileSystemHandleLike {}

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
    interface FileSystemHandleLike {}

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/interfaces/GetEntriesOptions.html b/api/interfaces/GetEntriesOptions.html index f1569996..11c7918c 100644 --- a/api/interfaces/GetEntriesOptions.html +++ b/api/interfaces/GetEntriesOptions.html @@ -1,11 +1,11 @@ GetEntriesOptions | @zip.js/zip.js

    Interface GetEntriesOptions

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

    -
    interface GetEntriesOptions {
        commentEncoding?: string;
        filenameEncoding?: string;
        decodeText?(value, encoding): string;
    }

    Hierarchy (view full)

    Properties

    commentEncoding? +
    interface GetEntriesOptions {
        commentEncoding?: string;
        filenameEncoding?: string;
        decodeText?(value, encoding): string;
    }

    Hierarchy (view full)

    Properties

    commentEncoding? filenameEncoding?

    Methods

    decodeText?

    Properties

    Optional commentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    -

    Optional filenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    -

    Methods

    Optional decodeText

    • decodeText(value, encoding): string

    • Decodes the filename and the comment of the entry.

      +

    Optional filenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    +

    Methods

    Optional decodeText

    • decodeText(value, encoding): string

    • Decodes the filename and the comment of the entry.

      Parameters

      • value: Uint8Array

        The raw text value.

      • encoding: string

        The encoding of the text.

        -

      Returns string

      The decoded text value.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    commentEncodingfilenameEncodingdecodeText
    \ No newline at end of file +

    Returns string

    The decoded text value or undefined if the raw text value should be decoded by zip.js.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    commentEncodingfilenameEncodingdecodeText
    \ No newline at end of file diff --git a/api/interfaces/HttpOptions.html b/api/interfaces/HttpOptions.html index 74460420..91c4a8fb 100644 --- a/api/interfaces/HttpOptions.html +++ b/api/interfaces/HttpOptions.html @@ -1,5 +1,5 @@ HttpOptions | @zip.js/zip.js

    Interface HttpOptions

    Represents the options passed to the constructor of HttpReader.

    -
    interface HttpOptions {
        combineSizeEocd?: boolean;
        forceRangeRequests?: boolean;
        headers?: Iterable<[string, string]> | Map<string, string>;
        preventHeadRequest?: boolean;
        useRangeHeader?: boolean;
        useXHR?: boolean;
    }

    Hierarchy (view full)

    Properties

    combineSizeEocd? +
    interface HttpOptions {
        combineSizeEocd?: boolean;
        forceRangeRequests?: boolean;
        headers?: Iterable<[string, string]> | Map<string, string>;
        preventHeadRequest?: boolean;
        useRangeHeader?: boolean;
        useXHR?: boolean;
    }

    Hierarchy (view full)

    Properties

    combineSizeEocd? forceRangeRequests? headers? preventHeadRequest? @@ -8,18 +8,18 @@

    Properties

    Optional combineSizeEocd

    combineSizeEocd?: boolean

    true to use Range: bytes=-22 on the first request and cache the EOCD, make sure beforehand that the server supports a suffix range request.

    Default Value

    false
    -

    Optional forceRangeRequests

    forceRangeRequests?: boolean

    true to always use Range headers when fetching data.

    +

    Optional forceRangeRequests

    forceRangeRequests?: boolean

    true to always use Range headers when fetching data.

    Default Value

    false
    -

    Optional headers

    headers?: Iterable<[string, string]> | Map<string, string>

    The HTTP headers.

    -

    Optional preventHeadRequest

    preventHeadRequest?: boolean

    true to prevent using HEAD HTTP request in order the get the size of the content. +

    Optional headers

    headers?: Iterable<[string, string]> | Map<string, string>

    The HTTP headers.

    +

    Optional preventHeadRequest

    preventHeadRequest?: boolean

    true to prevent using HEAD HTTP request in order the get the size of the content. false to explicitly use HEAD, this is useful in case of CORS where Access-Control-Expose-Headers: Content-Range is not returned by the server.

    Default Value

    false
    -

    Optional useRangeHeader

    useRangeHeader?: boolean

    true to use Range headers when fetching data from servers returning Accept-Ranges headers.

    +

    Optional useRangeHeader

    useRangeHeader?: boolean

    true to use Range headers when fetching data from servers returning Accept-Ranges headers.

    Default Value

    false
    -

    Optional useXHR

    useXHR?: boolean

    true to rely XMLHttpRequest instead of fetch to fetch data.

    +

    Optional useXHR

    useXHR?: boolean

    true to rely XMLHttpRequest instead of fetch to fetch data.

    Default Value

    false
    -

    Settings

    Member Visibility

    Theme

    On This Page

    combineSizeEocdforceRangeRequestsheaderspreventHeadRequestuseRangeHeaderuseXHR
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    combineSizeEocdforceRangeRequestsheaderspreventHeadRequestuseRangeHeaderuseXHR
    \ No newline at end of file diff --git a/api/interfaces/HttpRangeOptions.html b/api/interfaces/HttpRangeOptions.html index 0154bf1e..b807cf5a 100644 --- a/api/interfaces/HttpRangeOptions.html +++ b/api/interfaces/HttpRangeOptions.html @@ -1,8 +1,8 @@ HttpRangeOptions | @zip.js/zip.js

    Interface HttpRangeOptions

    Represents options passed to the constructor of HttpRangeReader and HttpReader.

    -
    interface HttpRangeOptions {
        headers?: Iterable<[string, string]> | Map<string, string>;
        useXHR?: boolean;
    }

    Hierarchy (view full)

    Properties

    headers? +
    interface HttpRangeOptions {
        headers?: Iterable<[string, string]> | Map<string, string>;
        useXHR?: boolean;
    }

    Hierarchy (view full)

    Properties

    headers? useXHR?

    Properties

    Optional headers

    headers?: Iterable<[string, string]> | Map<string, string>

    The HTTP headers.

    -

    Optional useXHR

    useXHR?: boolean

    true to rely XMLHttpRequest instead of fetch to fetch data.

    +

    Optional useXHR

    useXHR?: boolean

    true to rely XMLHttpRequest instead of fetch to fetch data.

    Default Value

    false
    -

    Settings

    Member Visibility

    Theme

    On This Page

    headersuseXHR
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    headersuseXHR
    \ No newline at end of file diff --git a/api/interfaces/Initializable.html b/api/interfaces/Initializable.html index d40eefd5..457693e2 100644 --- a/api/interfaces/Initializable.html +++ b/api/interfaces/Initializable.html @@ -1,6 +1,6 @@ Initializable | @zip.js/zip.js

    Interface Initializable

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

    zip.js can handle multiple types of data thanks to a generic API. This feature is based on 2 abstract constructors: Reader and Writer. The classes inheriting from Reader help to read data from a source of data. The classes inheriting from Writer help to write data into a destination.

    -
    interface Initializable {
        init?(): Promise<void>;
    }

    Implemented by

    Methods

    init? +
    interface Initializable {
        init?(): Promise<void>;
    }

    Implemented by

    Methods

    init?

    Methods

    Optional init

    • init(): Promise<void>

    • Initializes the instance asynchronously

      -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    init
    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    init
    \ No newline at end of file diff --git a/api/interfaces/ReadableReader.html b/api/interfaces/ReadableReader.html index 1fe26835..0e01a156 100644 --- a/api/interfaces/ReadableReader.html +++ b/api/interfaces/ReadableReader.html @@ -1,4 +1,4 @@ ReadableReader | @zip.js/zip.js

    Interface ReadableReader

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

    -
    interface ReadableReader {
        readable: ReadableStream<any>;
    }

    Implemented by

    Properties

    readable +
    interface ReadableReader {
        readable: ReadableStream<any>;
    }

    Implemented by

    Properties

    readable

    Properties

    readable

    readable: ReadableStream<any>

    The ReadableStream instance.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    readable
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    readable
    \ No newline at end of file diff --git a/api/interfaces/URLString.html b/api/interfaces/URLString.html index 6c9395b4..ecbb50de 100644 --- a/api/interfaces/URLString.html +++ b/api/interfaces/URLString.html @@ -1,8 +1,7 @@ URLString | @zip.js/zip.js

    Interface URLString

    Represents a URL stored into a string.

    -
    interface URLString {
        length: number;
        [iterator](): IterableIterator<string>;
        anchor(name): string;
        at(index): string;
        big(): string;
        blink(): string;
        bold(): string;
        charAt(pos): string;
        charCodeAt(index): number;
        codePointAt(pos): number;
        concat(...strings): string;
        endsWith(searchString, endPosition?): boolean;
        fixed(): string;
        fontcolor(color): string;
        fontsize(size): string;
        fontsize(size): string;
        includes(searchString, position?): boolean;
        indexOf(searchString, position?): number;
        italics(): string;
        lastIndexOf(searchString, position?): number;
        link(url): string;
        localeCompare(that): number;
        localeCompare(that, locales?, options?): number;
        localeCompare(that, locales?, options?): number;
        match(regexp): RegExpMatchArray;
        match(matcher): RegExpMatchArray;
        matchAll(regexp): IterableIterator<RegExpExecArray>;
        normalize(form): string;
        normalize(form?): string;
        padEnd(maxLength, fillString?): string;
        padStart(maxLength, fillString?): string;
        repeat(count): string;
        replace(searchValue, replaceValue): string;
        replace(searchValue, replacer): string;
        replace(searchValue, replaceValue): string;
        replace(searchValue, replacer): string;
        search(regexp): number;
        search(searcher): number;
        slice(start?, end?): string;
        small(): string;
        split(separator, limit?): string[];
        split(splitter, limit?): string[];
        startsWith(searchString, position?): boolean;
        strike(): string;
        sub(): string;
        substr(from, length?): string;
        substring(start, end?): string;
        sup(): string;
        toLocaleLowerCase(locales?): string;
        toLocaleLowerCase(locales?): string;
        toLocaleUpperCase(locales?): string;
        toLocaleUpperCase(locales?): string;
        toLowerCase(): string;
        toString(): string;
        toUpperCase(): string;
        trim(): string;
        trimEnd(): string;
        trimLeft(): string;
        trimRight(): string;
        trimStart(): string;
        valueOf(): string;
    }

    Hierarchy

    • String
      • URLString

    Properties

    length +
    interface URLString {
        length: number;
        [iterator](): IterableIterator<string>;
        anchor(name): string;
        big(): string;
        blink(): string;
        bold(): string;
        charAt(pos): string;
        charCodeAt(index): number;
        codePointAt(pos): number;
        concat(...strings): string;
        endsWith(searchString, endPosition?): boolean;
        fixed(): string;
        fontcolor(color): string;
        fontsize(size): string;
        fontsize(size): string;
        includes(searchString, position?): boolean;
        indexOf(searchString, position?): number;
        italics(): string;
        lastIndexOf(searchString, position?): number;
        link(url): string;
        localeCompare(that): number;
        localeCompare(that, locales?, options?): number;
        match(regexp): RegExpMatchArray;
        match(matcher): RegExpMatchArray;
        normalize(form): string;
        normalize(form?): string;
        padEnd(maxLength, fillString?): string;
        padStart(maxLength, fillString?): string;
        repeat(count): string;
        replace(searchValue, replaceValue): string;
        replace(searchValue, replacer): string;
        replace(searchValue, replaceValue): string;
        replace(searchValue, replacer): string;
        search(regexp): number;
        search(searcher): number;
        slice(start?, end?): string;
        small(): string;
        split(separator, limit?): string[];
        split(splitter, limit?): string[];
        startsWith(searchString, position?): boolean;
        strike(): string;
        sub(): string;
        substr(from, length?): string;
        substring(start, end?): string;
        sup(): string;
        toLocaleLowerCase(locales?): string;
        toLocaleUpperCase(locales?): string;
        toLowerCase(): string;
        toString(): string;
        toUpperCase(): string;
        trim(): string;
        valueOf(): string;
    }

    Hierarchy

    • String
      • URLString

    Properties

    length

    Methods

    [iterator] anchor -at big blink bold @@ -21,7 +20,6 @@ link localeCompare match -matchAll normalize padEnd padStart @@ -43,19 +41,12 @@ toString toUpperCase trim -trimEnd -trimLeft -trimRight -trimStart valueOf

    Properties

    Readonly length

    length: number

    Returns the length of a String object.

    Methods

    [iterator]

    • [iterator](): IterableIterator<string>

    • Iterator

      Returns IterableIterator<string>

    anchor

    • anchor(name): string

    • Returns an <a> HTML anchor element and sets the name attribute to the text value

      Parameters

      • name: string

      Returns string

      Deprecated

      A legacy feature for browser compatibility

      -

    at

    • at(index): string

    • Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

      -

      Parameters

      • index: number

      Returns string

    big

    • big(): string

    • Returns a <big> HTML element

      +

    big

    • big(): string

    • Returns a <big> HTML element

      Returns string

      Deprecated

      A legacy feature for browser compatibility

    blink

    • blink(): string

    • Returns a <blink> HTML element

      Returns string

      Deprecated

      A legacy feature for browser compatibility

      @@ -104,19 +95,12 @@

      Parameters

      • that: string

        String to compare to target string

      • Optional locales: string | string[]

        A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.

      • Optional options: CollatorOptions

        An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

        -

      Returns number

    • localeCompare(that, locales?, options?): number

    • Determines whether two strings are equivalent in the current or specified locale.

      -

      Parameters

      • that: string

        String to compare to target string

        -
      • Optional locales: LocalesArgument

        A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. This parameter must conform to BCP 47 standards; see the Intl.Collator object for details.

        -
      • Optional options: CollatorOptions

        An object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.

        -

      Returns number

    match

    • match(regexp): RegExpMatchArray

    • Matches a string with a regular expression, and returns an array containing the results of that search.

      +

    Returns number

    match

    • match(regexp): RegExpMatchArray

    • Matches a string with a regular expression, and returns an array containing the results of that search.

      Parameters

      • regexp: string | RegExp

        A variable name or string literal containing the regular expression pattern and flags.

      Returns RegExpMatchArray

    • match(matcher): RegExpMatchArray

    • Matches a string or an object that supports being matched against, and returns an array containing the results of that search, or null if no matches are found.

      Parameters

      • matcher: {
            [match](string): RegExpMatchArray;
        }

        An object that supports being matched against.

        -
        • [match]:function
          • [match](string): RegExpMatchArray

          • Parameters

            • string: string

            Returns RegExpMatchArray

      Returns RegExpMatchArray

    matchAll

    • matchAll(regexp): IterableIterator<RegExpExecArray>

    • Matches a string with a regular expression, and returns an iterable of matches -containing the results of that search.

      -

      Parameters

      • regexp: RegExp

        A variable name or string literal containing the regular expression pattern and flags.

        -

      Returns IterableIterator<RegExpExecArray>

    normalize

    • normalize(form): string

    • Returns the String value result of normalizing the string into the normalization form +

      • [match]:function
        • [match](string): RegExpMatchArray

        • Parameters

          • string: string

          Returns RegExpMatchArray

    Returns RegExpMatchArray

    normalize

    • normalize(form): string

    • Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

      Parameters

      • form: "NFC" | "NFD" | "NFKC" | "NFKD"

        Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

        @@ -187,18 +171,10 @@

      Returns string

    sup

    • sup(): string

    • Returns a <sup> HTML element

      Returns string

      Deprecated

      A legacy feature for browser compatibility

    toLocaleLowerCase

    • toLocaleLowerCase(locales?): string

    • Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

      -

      Parameters

      • Optional locales: string | string[]

      Returns string

    • toLocaleLowerCase(locales?): string

    • Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

      -

      Parameters

      • Optional locales: LocalesArgument

      Returns string

    toLocaleUpperCase

    • toLocaleUpperCase(locales?): string

    • Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

      -

      Parameters

      • Optional locales: string | string[]

      Returns string

    • toLocaleUpperCase(locales?): string

    • Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

      -

      Parameters

      • Optional locales: LocalesArgument

      Returns string

    toLowerCase

    • toLowerCase(): string

    • Converts all the alphabetic characters in a string to lowercase.

      +

      Parameters

      • Optional locales: string | string[]

      Returns string

    toLocaleUpperCase

    • toLocaleUpperCase(locales?): string

    • Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

      +

      Parameters

      • Optional locales: string | string[]

      Returns string

    toLowerCase

    • toLowerCase(): string

    • Converts all the alphabetic characters in a string to lowercase.

      Returns string

    toString

    • toString(): string

    • Returns a string representation of a string.

      Returns string

    toUpperCase

    • toUpperCase(): string

    • Converts all the alphabetic characters in a string to uppercase.

      Returns string

    trim

    • trim(): string

    • Removes the leading and trailing white space and line terminator characters from a string.

      -

      Returns string

    trimEnd

    • trimEnd(): string

    • Removes the trailing white space and line terminator characters from a string.

      -

      Returns string

    trimLeft

    • trimLeft(): string

    • Removes the leading white space and line terminator characters from a string.

      -

      Returns string

      Deprecated

      A legacy feature for browser compatibility. Use trimStart instead

      -

    trimRight

    • trimRight(): string

    • Removes the trailing white space and line terminator characters from a string.

      -

      Returns string

      Deprecated

      A legacy feature for browser compatibility. Use trimEnd instead

      -

    trimStart

    • trimStart(): string

    • Removes the leading white space and line terminator characters from a string.

      -

      Returns string

    valueOf

    • valueOf(): string

    • Returns the primitive value of the specified object.

      -

      Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    length[iterator]anchoratbigblinkboldcharAtcharCodeAtcodePointAtconcatendsWithfixedfontcolorfontsizeincludesindexOfitalicslastIndexOflinklocaleComparematchmatchAllnormalizepadEndpadStartrepeatreplacesearchslicesmallsplitstartsWithstrikesubsubstrsubstringsuptoLocaleLowerCasetoLocaleUpperCasetoLowerCasetoStringtoUpperCasetrimtrimEndtrimLefttrimRighttrimStartvalueOf
    \ No newline at end of file +

    Returns string

    valueOf

    Settings

    Member Visibility

    Theme

    On This Page

    length[iterator]anchorbigblinkboldcharAtcharCodeAtcodePointAtconcatendsWithfixedfontcolorfontsizeincludesindexOfitalicslastIndexOflinklocaleComparematchnormalizepadEndpadStartrepeatreplacesearchslicesmallsplitstartsWithstrikesubsubstrsubstringsuptoLocaleLowerCasetoLocaleUpperCasetoLowerCasetoStringtoUpperCasetrimvalueOf
    \ No newline at end of file diff --git a/api/interfaces/WorkerConfiguration.html b/api/interfaces/WorkerConfiguration.html index 485877b1..157028b6 100644 --- a/api/interfaces/WorkerConfiguration.html +++ b/api/interfaces/WorkerConfiguration.html @@ -1,10 +1,10 @@ WorkerConfiguration | @zip.js/zip.js

    Interface WorkerConfiguration

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

    -
    interface WorkerConfiguration {
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
    }

    Hierarchy (view full)

    Properties

    useCompressionStream? +
    interface WorkerConfiguration {
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
    }

    Hierarchy (view full)

    Properties

    useCompressionStream? useWebWorkers?

    Properties

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    Default Value

    true
    -

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    +

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    Default Value

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    useCompressionStreamuseWebWorkers
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    useCompressionStreamuseWebWorkers
    \ No newline at end of file diff --git a/api/interfaces/WritableWriter.html b/api/interfaces/WritableWriter.html index bcae3982..233680ad 100644 --- a/api/interfaces/WritableWriter.html +++ b/api/interfaces/WritableWriter.html @@ -1,6 +1,6 @@ WritableWriter | @zip.js/zip.js

    Interface WritableWriter

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

    -
    interface WritableWriter {
        maxSize?: number;
        writable: WritableStream<any>;
    }

    Implemented by

    Properties

    maxSize? +
    interface WritableWriter {
        maxSize?: number;
        writable: WritableStream<any>;
    }

    Implemented by

    Properties

    maxSize? writable

    Properties

    Optional maxSize

    maxSize?: number

    The maximum size of split data when creating a ZipWriter instance or when calling Entry#getData with a generator of WritableWriter instances.

    -

    writable

    writable: WritableStream<any>

    The WritableStream instance.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    maxSizewritable
    \ No newline at end of file +

    writable

    writable: WritableStream<any>

    The WritableStream instance.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    maxSizewritable
    \ No newline at end of file diff --git a/api/interfaces/ZipDirectoryEntryExportOptions.html b/api/interfaces/ZipDirectoryEntryExportOptions.html index 1d37b7ae..1804115c 100644 --- a/api/interfaces/ZipDirectoryEntryExportOptions.html +++ b/api/interfaces/ZipDirectoryEntryExportOptions.html @@ -1,5 +1,5 @@ ZipDirectoryEntryExportOptions | @zip.js/zip.js

    Interface ZipDirectoryEntryExportOptions

    Represents the options passed to {@link ZipDirectoryEntry}#export*().

    -
    interface ZipDirectoryEntryExportOptions {
        bufferedWrite?: boolean;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        mimeType?: string;
        msDosCompatible?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        readerOptions?: ZipReaderConstructorOptions;
        relativePath?: boolean;
        signal?: AbortSignal;
        supportZip64SplitFile?: boolean;
        usdz?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText?(text): Uint8Array;
        onend?(computedSize): Promise<void>;
        onprogress?(progress, total): Promise<void>;
        onstart?(total): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    bufferedWrite? +
    interface ZipDirectoryEntryExportOptions {
        bufferedWrite?: boolean;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        mimeType?: string;
        msDosCompatible?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        readerOptions?: ZipReaderConstructorOptions;
        relativePath?: boolean;
        signal?: AbortSignal;
        supportZip64SplitFile?: boolean;
        usdz?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText?(text): Uint8Array;
        onend?(computedSize): Promise<void>;
        onprogress?(progress, total): Promise<void>;
        onstart?(total): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    bufferedWrite? creationDate? dataDescriptor? dataDescriptorSignature? @@ -33,87 +33,87 @@

    bufferedWrite is automatically set to true when compressing more than one entry in parallel.

    Default Value

    false
    -

    Optional creationDate

    creationDate?: Date

    The creation date.

    +

    Optional creationDate

    creationDate?: Date

    The creation date.

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    Default Value

    The current date.
    -

    Optional dataDescriptor

    dataDescriptor?: boolean

    true to to add a data descriptor.

    +

    Optional dataDescriptor

    dataDescriptor?: boolean

    true to to add a data descriptor.

    When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.

    Default Value

    true
    -

    Optional dataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    +

    Optional dataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    Default Value

    false
    -

    Optional encryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    +

    Optional encryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    Default Value

    3
    -

    Optional extendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    +

    Optional extendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    When set to false, the maximum last modification date cannot exceed November 31, 2107 and the maximum accuracy is 2 seconds.

    Default Value

    true
    -

    Optional externalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    +

    Optional externalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    Default Value

    0
    -

    Optional internalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    +

    Optional internalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    Default Value

    0
    -

    Optional keepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    -

    When set to true, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the zip54 option to true explicitly. +

    Optional keepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    +

    When set to true, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the zip64 option to true explicitly. Another solution to improve the use of web workers is to add entries from smallest to largest in uncompressed size.

    Default Value

    true
    -

    Optional lastAccessDate

    lastAccessDate?: Date

    The last access date.

    +

    Optional lastAccessDate

    lastAccessDate?: Date

    The last access date.

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    Default Value

    The current date.
    -

    Optional lastModDate

    lastModDate?: Date

    The last modification date.

    +

    Optional lastModDate

    lastModDate?: Date

    The last modification date.

    Default Value

    The current date.
    -

    Optional level

    level?: number

    The level of compression.

    +

    Optional level

    level?: number

    The level of compression.

    The minimum value is 0 and means that no compression is applied. The maximum value is 9.

    Default Value

    5
    -

    Optional mimeType

    mimeType?: string

    The MIME type of the exported data when relevant.

    -

    Optional msDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    +

    Optional mimeType

    mimeType?: string

    The MIME type of the exported data when relevant.

    +

    Optional msDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    Default Value

    true
    -

    Optional password

    password?: string

    The password used to encrypt the content of the entry.

    -

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    +

    Optional password

    password?: string

    The password used to encrypt the content of the entry.

    +

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    Default Value

    false
    -

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optional readerOptions

    readerOptions?: ZipReaderConstructorOptions

    The options passed to the Reader instances

    -

    Optional relativePath

    relativePath?: boolean

    true to use filenames relative to the entry instead of full filenames.

    -

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    -

    Optional supportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    +

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    +

    Optional readerOptions

    readerOptions?: ZipReaderConstructorOptions

    The options passed to the Reader instances

    +

    Optional relativePath

    relativePath?: boolean

    true to use filenames relative to the entry instead of full filenames.

    +

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    +

    Optional supportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    Default Value

    true
    -

    Optional usdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    +

    Optional usdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    Default Value

    false
    -

    Optional version

    version?: number

    The "Version" field.

    -

    Optional versionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    +

    Optional version

    version?: number

    The "Version" field.

    +

    Optional versionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    Default Value

    20
    -

    Optional zip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    +

    Optional zip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    zip64 is automatically set to true when necessary (e.g. compressed data larger than 4GB or with unknown size).

    Default Value

    false
    -

    Optional zipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    +

    Optional zipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    It is not recommended to set zipCrypto to true because the ZipCrypto encryption can be easily broken.

    Default Value

    false
    -

    Methods

    Optional encodeText

    Methods

    Optional encodeText

    Optional onend

    • onend(computedSize): Promise<void>

    • The function called when ending compression/decompression.

      +

    Returns Uint8Array

    The encoded text or undefined if the text should be encoded by zip.js.

    +

    Optional onend

    • onend(computedSize): Promise<void>

    • The function called when ending compression/decompression.

      Parameters

      • computedSize: number

        The total number of bytes (computed).

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optional onprogress

    Optional onprogress

    • onprogress(progress, total): Promise<void>

    • The function called during compression/decompression.

      Parameters

      • progress: number

        The current progress in bytes.

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optional onstart

    Optional onstart

    • onstart(total): Promise<void>

    • The function called when starting compression/decompression.

      Parameters

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    bufferedWritecreationDatedataDescriptordataDescriptorSignatureencryptionStrengthextendedTimestampexternalFileAttributeinternalFileAttributekeepOrderlastAccessDatelastModDatelevelmimeTypemsDosCompatiblepasswordpreventCloserawPasswordreaderOptionsrelativePathsignalsupportZip64SplitFileusdzversionversionMadeByzip64zipCryptoencodeTextonendonprogressonstart
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    bufferedWritecreationDatedataDescriptordataDescriptorSignatureencryptionStrengthextendedTimestampexternalFileAttributeinternalFileAttributekeepOrderlastAccessDatelastModDatelevelmimeTypemsDosCompatiblepasswordpreventCloserawPasswordreaderOptionsrelativePathsignalsupportZip64SplitFileusdzversionversionMadeByzip64zipCryptoencodeTextonendonprogressonstart
    \ No newline at end of file diff --git a/api/interfaces/ZipDirectoryEntryImportHttpOptions.html b/api/interfaces/ZipDirectoryEntryImportHttpOptions.html index aa024010..11534a59 100644 --- a/api/interfaces/ZipDirectoryEntryImportHttpOptions.html +++ b/api/interfaces/ZipDirectoryEntryImportHttpOptions.html @@ -1,5 +1,5 @@ ZipDirectoryEntryImportHttpOptions | @zip.js/zip.js

    Interface ZipDirectoryEntryImportHttpOptions

    Represents the options passed to ZipDirectoryEntry#importHttpContent.

    -
    interface ZipDirectoryEntryImportHttpOptions {
        checkSignature?: boolean;
        combineSizeEocd?: boolean;
        commentEncoding?: string;
        extractAppendedData?: boolean;
        extractPrependedData?: boolean;
        filenameEncoding?: string;
        forceRangeRequests?: boolean;
        headers?: Iterable<[string, string]> | Map<string, string>;
        password?: string;
        preventClose?: boolean;
        preventHeadRequest?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useRangeHeader?: boolean;
        useWebWorkers?: boolean;
        useXHR?: boolean;
        decodeText?(value, encoding): string;
    }

    Hierarchy (view full)

    Properties

    checkSignature? +
    interface ZipDirectoryEntryImportHttpOptions {
        checkSignature?: boolean;
        combineSizeEocd?: boolean;
        commentEncoding?: string;
        extractAppendedData?: boolean;
        extractPrependedData?: boolean;
        filenameEncoding?: string;
        forceRangeRequests?: boolean;
        headers?: Iterable<[string, string]> | Map<string, string>;
        password?: string;
        preventClose?: boolean;
        preventHeadRequest?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useRangeHeader?: boolean;
        useWebWorkers?: boolean;
        useXHR?: boolean;
        decodeText?(value, encoding): string;
    }

    Hierarchy (view full)

    Properties

    checkSignature? combineSizeEocd? commentEncoding? extractAppendedData? @@ -21,48 +21,48 @@

    Properties

    Optional checkSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    Default Value

    false
    -

    Optional combineSizeEocd

    combineSizeEocd?: boolean

    true to use Range: bytes=-22 on the first request and cache the EOCD, make sure beforehand that the server supports a suffix range request.

    +

    Optional combineSizeEocd

    combineSizeEocd?: boolean

    true to use Range: bytes=-22 on the first request and cache the EOCD, make sure beforehand that the server supports a suffix range request.

    Default Value

    false
    -

    Optional commentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    -

    Optional extractAppendedData

    extractAppendedData?: boolean

    true to extract the appended data into ZipReader#appendedData.

    +

    Optional commentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    +

    Optional extractAppendedData

    extractAppendedData?: boolean

    true to extract the appended data into ZipReader#appendedData.

    Default Value

    false
    -

    Optional extractPrependedData

    extractPrependedData?: boolean

    true to extract the prepended data into ZipReader#prependedData.

    +

    Optional extractPrependedData

    extractPrependedData?: boolean

    true to extract the prepended data into ZipReader#prependedData.

    Default Value

    false
    -

    Optional filenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    -

    Optional forceRangeRequests

    forceRangeRequests?: boolean

    true to always use Range headers when fetching data.

    +

    Optional filenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    +

    Optional forceRangeRequests

    forceRangeRequests?: boolean

    true to always use Range headers when fetching data.

    Default Value

    false
    -

    Optional headers

    headers?: Iterable<[string, string]> | Map<string, string>

    The HTTP headers.

    -

    Optional password

    password?: string

    The password used to decrypt the content of the entry.

    -

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    +

    Optional headers

    headers?: Iterable<[string, string]> | Map<string, string>

    The HTTP headers.

    +

    Optional password

    password?: string

    The password used to decrypt the content of the entry.

    +

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    Default Value

    false
    -

    Optional preventHeadRequest

    preventHeadRequest?: boolean

    true to prevent using HEAD HTTP request in order the get the size of the content. +

    Optional preventHeadRequest

    preventHeadRequest?: boolean

    true to prevent using HEAD HTTP request in order the get the size of the content. false to explicitly use HEAD, this is useful in case of CORS where Access-Control-Expose-Headers: Content-Range is not returned by the server.

    Default Value

    false
    -

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    -

    Optional transferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    +

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    +

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    +

    Optional transferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    Default Value

    true
    -

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    +

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    Default Value

    true
    -

    Optional useRangeHeader

    useRangeHeader?: boolean

    true to use Range headers when fetching data from servers returning Accept-Ranges headers.

    +

    Optional useRangeHeader

    useRangeHeader?: boolean

    true to use Range headers when fetching data from servers returning Accept-Ranges headers.

    Default Value

    false
    -

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    +

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    Default Value

    true
    -

    Optional useXHR

    useXHR?: boolean

    true to rely XMLHttpRequest instead of fetch to fetch data.

    +

    Optional useXHR

    useXHR?: boolean

    true to rely XMLHttpRequest instead of fetch to fetch data.

    Default Value

    false
    -

    Methods

    Optional decodeText

    Methods

    Optional decodeText

    • decodeText(value, encoding): string

    • Decodes the filename and the comment of the entry.

      Parameters

      • value: Uint8Array

        The raw text value.

      • encoding: string

        The encoding of the text.

        -

      Returns string

      The decoded text value.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    checkSignaturecombineSizeEocdcommentEncodingextractAppendedDataextractPrependedDatafilenameEncodingforceRangeRequestsheaderspasswordpreventClosepreventHeadRequestrawPasswordsignaltransferStreamsuseCompressionStreamuseRangeHeaderuseWebWorkersuseXHRdecodeText
    \ No newline at end of file +

    Returns string

    The decoded text value or undefined if the raw text value should be decoded by zip.js.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    checkSignaturecombineSizeEocdcommentEncodingextractAppendedDataextractPrependedDatafilenameEncodingforceRangeRequestsheaderspasswordpreventClosepreventHeadRequestrawPasswordsignaltransferStreamsuseCompressionStreamuseRangeHeaderuseWebWorkersuseXHRdecodeText
    \ No newline at end of file diff --git a/api/interfaces/ZipLibrary.html b/api/interfaces/ZipLibrary.html index 8a49c11f..277c7c95 100644 --- a/api/interfaces/ZipLibrary.html +++ b/api/interfaces/ZipLibrary.html @@ -1,10 +1,10 @@ ZipLibrary | @zip.js/zip.js

    Interface ZipLibrary

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

    -
    interface ZipLibrary {
        Deflate: typeof ZipDeflate;
        Inflate: typeof ZipInflate;
    }

    Properties

    Deflate +
    interface ZipLibrary {
        Deflate: typeof ZipDeflate;
        Inflate: typeof ZipInflate;
    }

    Properties

    Deflate Inflate

    Properties

    Deflate

    Deflate: typeof ZipDeflate

    The class used to compress data.

    Default Value

    {@link ZipDeflate}
    -

    Inflate

    Inflate: typeof ZipInflate

    The class used to decompress data.

    +

    Inflate

    Inflate: typeof ZipInflate

    The class used to decompress data.

    Default Value

    {@link ZipInflate}
    -

    Settings

    Member Visibility

    Theme

    On This Page

    DeflateInflate
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    DeflateInflate
    \ No newline at end of file diff --git a/api/interfaces/ZipReaderCheckPasswordOptions.html b/api/interfaces/ZipReaderCheckPasswordOptions.html index 5e78c957..2ae9acde 100644 --- a/api/interfaces/ZipReaderCheckPasswordOptions.html +++ b/api/interfaces/ZipReaderCheckPasswordOptions.html @@ -1,6 +1,6 @@ ZipReaderCheckPasswordOptions | @zip.js/zip.js

    Interface ZipReaderCheckPasswordOptions

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

    -
    interface ZipReaderCheckPasswordOptions {
        checkPasswordOnly: boolean;
    }

    Hierarchy (view full)

    Properties

    checkPasswordOnly +
    interface ZipReaderCheckPasswordOptions {
        checkPasswordOnly: boolean;
    }

    Hierarchy (view full)

    Properties

    checkPasswordOnly

    Properties

    checkPasswordOnly

    checkPasswordOnly: boolean

    true to check only if the password is valid.

    Default Value

    false
    -

    Settings

    Member Visibility

    Theme

    On This Page

    checkPasswordOnly
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    checkPasswordOnly
    \ No newline at end of file diff --git a/api/interfaces/ZipReaderConstructorOptions.html b/api/interfaces/ZipReaderConstructorOptions.html index 42e9db3d..7209406c 100644 --- a/api/interfaces/ZipReaderConstructorOptions.html +++ b/api/interfaces/ZipReaderConstructorOptions.html @@ -1,5 +1,5 @@ ZipReaderConstructorOptions | @zip.js/zip.js

    Interface ZipReaderConstructorOptions

    Represents the options passed to the constructor of ZipReader, and {@link ZipDirectory}#import*.

    -
    interface ZipReaderConstructorOptions {
        checkSignature?: boolean;
        commentEncoding?: string;
        extractAppendedData?: boolean;
        extractPrependedData?: boolean;
        filenameEncoding?: string;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        decodeText?(value, encoding): string;
    }

    Hierarchy (view full)

    Properties

    checkSignature? +
    interface ZipReaderConstructorOptions {
        checkSignature?: boolean;
        commentEncoding?: string;
        extractAppendedData?: boolean;
        extractPrependedData?: boolean;
        filenameEncoding?: string;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        decodeText?(value, encoding): string;
    }

    Hierarchy (view full)

    Properties

    checkSignature? commentEncoding? extractAppendedData? extractPrependedData? @@ -15,31 +15,31 @@

    Properties

    Optional checkSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    Default Value

    false
    -

    Optional commentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    -

    Optional extractAppendedData

    extractAppendedData?: boolean

    true to extract the appended data into ZipReader#appendedData.

    +

    Optional commentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    +

    Optional extractAppendedData

    extractAppendedData?: boolean

    true to extract the appended data into ZipReader#appendedData.

    Default Value

    false
    -

    Optional extractPrependedData

    extractPrependedData?: boolean

    true to extract the prepended data into ZipReader#prependedData.

    +

    Optional extractPrependedData

    extractPrependedData?: boolean

    true to extract the prepended data into ZipReader#prependedData.

    Default Value

    false
    -

    Optional filenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    -

    Optional password

    password?: string

    The password used to decrypt the content of the entry.

    -

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    +

    Optional filenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    +

    Optional password

    password?: string

    The password used to decrypt the content of the entry.

    +

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    Default Value

    false
    -

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    -

    Optional transferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    +

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    +

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    +

    Optional transferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    Default Value

    true
    -

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    +

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    Default Value

    true
    -

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    +

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    Default Value

    true
    -

    Methods

    Optional decodeText

    Methods

    Optional decodeText

    • decodeText(value, encoding): string

    • Decodes the filename and the comment of the entry.

      Parameters

      • value: Uint8Array

        The raw text value.

      • encoding: string

        The encoding of the text.

        -

      Returns string

      The decoded text value.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    checkSignaturecommentEncodingextractAppendedDataextractPrependedDatafilenameEncodingpasswordpreventCloserawPasswordsignaltransferStreamsuseCompressionStreamuseWebWorkersdecodeText
    \ No newline at end of file +

    Returns string

    The decoded text value or undefined if the raw text value should be decoded by zip.js.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    checkSignaturecommentEncodingextractAppendedDataextractPrependedDatafilenameEncodingpasswordpreventCloserawPasswordsignaltransferStreamsuseCompressionStreamuseWebWorkersdecodeText
    \ No newline at end of file diff --git a/api/interfaces/ZipReaderGetEntriesOptions.html b/api/interfaces/ZipReaderGetEntriesOptions.html index 58ffb79b..b1fc5bf1 100644 --- a/api/interfaces/ZipReaderGetEntriesOptions.html +++ b/api/interfaces/ZipReaderGetEntriesOptions.html @@ -1,17 +1,17 @@ ZipReaderGetEntriesOptions | @zip.js/zip.js

    Interface ZipReaderGetEntriesOptions

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

    -
    interface ZipReaderGetEntriesOptions {
        commentEncoding?: string;
        filenameEncoding?: string;
        decodeText?(value, encoding): string;
        onprogress?(progress, total, entry): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    commentEncoding? +
    interface ZipReaderGetEntriesOptions {
        commentEncoding?: string;
        filenameEncoding?: string;
        decodeText?(value, encoding): string;
        onprogress?(progress, total, entry): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    commentEncoding? filenameEncoding?

    Methods

    decodeText? onprogress?

    Properties

    Optional commentEncoding

    commentEncoding?: string

    The encoding of the comment of the entry.

    -

    Optional filenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    -

    Methods

    Optional decodeText

    Optional filenameEncoding

    filenameEncoding?: string

    The encoding of the filename of the entry.

    +

    Methods

    Optional decodeText

    • decodeText(value, encoding): string

    • Decodes the filename and the comment of the entry.

      Parameters

      • value: Uint8Array

        The raw text value.

      • encoding: string

        The encoding of the text.

        -

      Returns string

      The decoded text value.

      -

    Optional onprogress

    • onprogress(progress, total, entry): Promise<void>

    • The function called each time an entry is read/written.

      +

    Returns string

    The decoded text value or undefined if the raw text value should be decoded by zip.js.

    +

    Optional onprogress

    • onprogress(progress, total, entry): Promise<void>

    • The function called each time an entry is read/written.

      Parameters

      • progress: number

        The entry index.

      • total: number

        The total number of entries.

      • entry: EntryMetaData

        The entry being read/written.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    commentEncodingfilenameEncodingdecodeTextonprogress
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    commentEncodingfilenameEncodingdecodeTextonprogress
    \ No newline at end of file diff --git a/api/interfaces/ZipReaderOptions.html b/api/interfaces/ZipReaderOptions.html index 2690d53f..23f972ab 100644 --- a/api/interfaces/ZipReaderOptions.html +++ b/api/interfaces/ZipReaderOptions.html @@ -1,5 +1,5 @@ ZipReaderOptions | @zip.js/zip.js

    Interface ZipReaderOptions

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

    -
    interface ZipReaderOptions {
        checkSignature?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
    }

    Hierarchy (view full)

    Properties

    checkSignature? +
    interface ZipReaderOptions {
        checkSignature?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        transferStreams?: boolean;
    }

    Hierarchy (view full)

    Properties

    checkSignature? password? preventClose? rawPassword? @@ -8,13 +8,13 @@

    Properties

    Optional checkSignature

    checkSignature?: boolean

    true to check the signature of the entry.

    Default Value

    false
    -

    Optional password

    password?: string

    The password used to decrypt the content of the entry.

    -

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    +

    Optional password

    password?: string

    The password used to decrypt the content of the entry.

    +

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of Writer#writable when calling Entry#getData.

    Default Value

    false
    -

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    -

    Optional transferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    +

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    +

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the decompression.

    +

    Optional transferStreams

    transferStreams?: boolean

    true to transfer streams to web workers when decompressing data.

    Default Value

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    checkSignaturepasswordpreventCloserawPasswordsignaltransferStreams
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    checkSignaturepasswordpreventCloserawPasswordsignaltransferStreams
    \ No newline at end of file diff --git a/api/interfaces/ZipWriterAddDataOptions.html b/api/interfaces/ZipWriterAddDataOptions.html index 944488a8..4ba05e3b 100644 --- a/api/interfaces/ZipWriterAddDataOptions.html +++ b/api/interfaces/ZipWriterAddDataOptions.html @@ -1,5 +1,5 @@ ZipWriterAddDataOptions | @zip.js/zip.js

    Interface ZipWriterAddDataOptions

    Represents the options passed to ZipWriter#add.

    -
    interface ZipWriterAddDataOptions {
        bufferedWrite?: boolean;
        comment?: string;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        directory?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        extraField?: Map<number, Uint8Array>;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        msDosCompatible?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        supportZip64SplitFile?: boolean;
        usdz?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText?(text): Uint8Array;
        onend?(computedSize): Promise<void>;
        onprogress?(progress, total): Promise<void>;
        onstart?(total): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    bufferedWrite? +
    interface ZipWriterAddDataOptions {
        bufferedWrite?: boolean;
        comment?: string;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        directory?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        extraField?: Map<number, Uint8Array>;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        msDosCompatible?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        supportZip64SplitFile?: boolean;
        usdz?: boolean;
        useCompressionStream?: boolean;
        useWebWorkers?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText?(text): Uint8Array;
        onend?(computedSize): Promise<void>;
        onprogress?(progress, total): Promise<void>;
        onstart?(total): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    bufferedWrite? comment? creationDate? dataDescriptor? @@ -35,95 +35,95 @@

    bufferedWrite is automatically set to true when compressing more than one entry in parallel.

    Default Value

    false
    -

    Optional comment

    comment?: string

    The comment of the entry.

    -

    Optional creationDate

    creationDate?: Date

    The creation date.

    +

    Optional comment

    comment?: string

    The comment of the entry.

    +

    Optional creationDate

    creationDate?: Date

    The creation date.

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    Default Value

    The current date.
    -

    Optional dataDescriptor

    dataDescriptor?: boolean

    true to to add a data descriptor.

    +

    Optional dataDescriptor

    dataDescriptor?: boolean

    true to to add a data descriptor.

    When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.

    Default Value

    true
    -

    Optional dataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    +

    Optional dataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    Default Value

    false
    -

    Optional directory

    directory?: boolean

    true if the entry is a directory.

    +

    Optional directory

    directory?: boolean

    true if the entry is a directory.

    Default Value

    false
    -

    Optional encryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    +

    Optional encryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    Default Value

    3
    -

    Optional extendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    +

    Optional extendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    When set to false, the maximum last modification date cannot exceed November 31, 2107 and the maximum accuracy is 2 seconds.

    Default Value

    true
    -

    Optional externalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    +

    Optional externalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    Default Value

    0
    -

    Optional extraField

    extraField?: Map<number, Uint8Array>

    The extra field of the entry.

    -

    Optional internalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    +

    Optional extraField

    extraField?: Map<number, Uint8Array>

    The extra field of the entry.

    +

    Optional internalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    Default Value

    0
    -

    Optional keepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    -

    When set to true, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the zip54 option to true explicitly. +

    Optional keepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    +

    When set to true, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the zip64 option to true explicitly. Another solution to improve the use of web workers is to add entries from smallest to largest in uncompressed size.

    Default Value

    true
    -

    Optional lastAccessDate

    lastAccessDate?: Date

    The last access date.

    +

    Optional lastAccessDate

    lastAccessDate?: Date

    The last access date.

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    Default Value

    The current date.
    -

    Optional lastModDate

    lastModDate?: Date

    The last modification date.

    +

    Optional lastModDate

    lastModDate?: Date

    The last modification date.

    Default Value

    The current date.
    -

    Optional level

    level?: number

    The level of compression.

    +

    Optional level

    level?: number

    The level of compression.

    The minimum value is 0 and means that no compression is applied. The maximum value is 9.

    Default Value

    5
    -

    Optional msDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    +

    Optional msDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    Default Value

    true
    -

    Optional password

    password?: string

    The password used to encrypt the content of the entry.

    -

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    +

    Optional password

    password?: string

    The password used to encrypt the content of the entry.

    +

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    Default Value

    false
    -

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    -

    Optional supportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    +

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    +

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    +

    Optional supportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    Default Value

    true
    -

    Optional usdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    +

    Optional usdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    Default Value

    false
    -

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    +

    Optional useCompressionStream

    useCompressionStream?: boolean

    true to use the native API CompressionStream/DecompressionStream to compress/decompress data.

    Default Value

    true
    -

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    +

    Optional useWebWorkers

    useWebWorkers?: boolean

    true to use web workers to compress/decompress data in non-blocking background processes.

    Default Value

    true
    -

    Optional version

    version?: number

    The "Version" field.

    -

    Optional versionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    +

    Optional version

    version?: number

    The "Version" field.

    +

    Optional versionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    Default Value

    20
    -

    Optional zip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    +

    Optional zip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    zip64 is automatically set to true when necessary (e.g. compressed data larger than 4GB or with unknown size).

    Default Value

    false
    -

    Optional zipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    +

    Optional zipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    It is not recommended to set zipCrypto to true because the ZipCrypto encryption can be easily broken.

    Default Value

    false
    -

    Methods

    Optional encodeText

    Methods

    Optional encodeText

    Optional onend

    • onend(computedSize): Promise<void>

    • The function called when ending compression/decompression.

      +

    Returns Uint8Array

    The encoded text or undefined if the text should be encoded by zip.js.

    +

    Optional onend

    • onend(computedSize): Promise<void>

    • The function called when ending compression/decompression.

      Parameters

      • computedSize: number

        The total number of bytes (computed).

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optional onprogress

    Optional onprogress

    • onprogress(progress, total): Promise<void>

    • The function called during compression/decompression.

      Parameters

      • progress: number

        The current progress in bytes.

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Optional onstart

    Optional onstart

    • onstart(total): Promise<void>

    • The function called when starting compression/decompression.

      Parameters

      • total: number

        The total number of bytes.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    bufferedWritecommentcreationDatedataDescriptordataDescriptorSignaturedirectoryencryptionStrengthextendedTimestampexternalFileAttributeextraFieldinternalFileAttributekeepOrderlastAccessDatelastModDatelevelmsDosCompatiblepasswordpreventCloserawPasswordsignalsupportZip64SplitFileusdzuseCompressionStreamuseWebWorkersversionversionMadeByzip64zipCryptoencodeTextonendonprogressonstart
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    bufferedWritecommentcreationDatedataDescriptordataDescriptorSignaturedirectoryencryptionStrengthextendedTimestampexternalFileAttributeextraFieldinternalFileAttributekeepOrderlastAccessDatelastModDatelevelmsDosCompatiblepasswordpreventCloserawPasswordsignalsupportZip64SplitFileusdzuseCompressionStreamuseWebWorkersversionversionMadeByzip64zipCryptoencodeTextonendonprogressonstart
    \ No newline at end of file diff --git a/api/interfaces/ZipWriterCloseOptions.html b/api/interfaces/ZipWriterCloseOptions.html index aafe9a60..75c1f451 100644 --- a/api/interfaces/ZipWriterCloseOptions.html +++ b/api/interfaces/ZipWriterCloseOptions.html @@ -1,16 +1,16 @@ ZipWriterCloseOptions | @zip.js/zip.js

    Interface ZipWriterCloseOptions

    Represents the options passed to ZipWriter#close.

    -
    interface ZipWriterCloseOptions {
        preventClose?: boolean;
        zip64?: boolean;
        onprogress?(progress, total, entry): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    preventClose? +
    interface ZipWriterCloseOptions {
        preventClose?: boolean;
        zip64?: boolean;
        onprogress?(progress, total, entry): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    preventClose? zip64?

    Methods

    onprogress?

    Properties

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    Default Value

    false
    -

    Optional zip64

    zip64?: boolean

    true to use Zip64 to write the entries directory.

    +

    Optional zip64

    zip64?: boolean

    true to use Zip64 to write the entries directory.

    Default Value

    false
    -

    Methods

    Optional onprogress

    • onprogress(progress, total, entry): Promise<void>

    • The function called each time an entry is read/written.

      +

    Methods

    Optional onprogress

    • onprogress(progress, total, entry): Promise<void>

    • The function called each time an entry is read/written.

      Parameters

      • progress: number

        The entry index.

      • total: number

        The total number of entries.

      • entry: EntryMetaData

        The entry being read/written.

      Returns Promise<void>

      An empty promise or undefined.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    preventClosezip64onprogress
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    preventClosezip64onprogress
    \ No newline at end of file diff --git a/api/interfaces/ZipWriterConstructorOptions.html b/api/interfaces/ZipWriterConstructorOptions.html index 53eddb6d..b45e517c 100644 --- a/api/interfaces/ZipWriterConstructorOptions.html +++ b/api/interfaces/ZipWriterConstructorOptions.html @@ -1,5 +1,5 @@ ZipWriterConstructorOptions | @zip.js/zip.js

    Interface ZipWriterConstructorOptions

    Represents options passed to the constructor of ZipWriter, ZipWriter#add and {@link ZipDirectoryEntry}#export*.

    -
    interface ZipWriterConstructorOptions {
        bufferedWrite?: boolean;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        msDosCompatible?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        supportZip64SplitFile?: boolean;
        usdz?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText?(text): Uint8Array;
    }

    Hierarchy (view full)

    Properties

    bufferedWrite? +
    interface ZipWriterConstructorOptions {
        bufferedWrite?: boolean;
        creationDate?: Date;
        dataDescriptor?: boolean;
        dataDescriptorSignature?: boolean;
        encryptionStrength?: 1 | 2 | 3;
        extendedTimestamp?: boolean;
        externalFileAttribute?: number;
        internalFileAttribute?: number;
        keepOrder?: boolean;
        lastAccessDate?: Date;
        lastModDate?: Date;
        level?: number;
        msDosCompatible?: boolean;
        password?: string;
        preventClose?: boolean;
        rawPassword?: Uint8Array;
        signal?: AbortSignal;
        supportZip64SplitFile?: boolean;
        usdz?: boolean;
        version?: number;
        versionMadeBy?: number;
        zip64?: boolean;
        zipCrypto?: boolean;
        encodeText?(text): Uint8Array;
    }

    Hierarchy (view full)

    Properties

    bufferedWrite? creationDate? dataDescriptor? dataDescriptorSignature? @@ -27,74 +27,74 @@

    bufferedWrite is automatically set to true when compressing more than one entry in parallel.

    Default Value

    false
    -

    Optional creationDate

    creationDate?: Date

    The creation date.

    +

    Optional creationDate

    creationDate?: Date

    The creation date.

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    Default Value

    The current date.
    -

    Optional dataDescriptor

    dataDescriptor?: boolean

    true to to add a data descriptor.

    +

    Optional dataDescriptor

    dataDescriptor?: boolean

    true to to add a data descriptor.

    When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.

    Default Value

    true
    -

    Optional dataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    +

    Optional dataDescriptorSignature

    dataDescriptorSignature?: boolean

    true to add the signature of the data descriptor.

    Default Value

    false
    -

    Optional encryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    +

    Optional encryptionStrength

    encryptionStrength?: 1 | 2 | 3

    The encryption strength (AES).

    Default Value

    3
    -

    Optional extendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    +

    Optional extendedTimestamp

    extendedTimestamp?: boolean

    true to store extended timestamp extra fields.

    When set to false, the maximum last modification date cannot exceed November 31, 2107 and the maximum accuracy is 2 seconds.

    Default Value

    true
    -

    Optional externalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    +

    Optional externalFileAttribute

    externalFileAttribute?: number

    The external file attribute.

    Default Value

    0
    -

    Optional internalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    +

    Optional internalFileAttribute

    internalFileAttribute?: number

    The internal file attribute.

    Default Value

    0
    -

    Optional keepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    -

    When set to true, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the zip54 option to true explicitly. +

    Optional keepOrder

    keepOrder?: boolean

    true to keep the order of the entry physically in the zip file.

    +

    When set to true, the use of web workers will be improved. However, it also prevents files larger than 4GB from being created without setting the zip64 option to true explicitly. Another solution to improve the use of web workers is to add entries from smallest to largest in uncompressed size.

    Default Value

    true
    -

    Optional lastAccessDate

    lastAccessDate?: Date

    The last access date.

    +

    Optional lastAccessDate

    lastAccessDate?: Date

    The last access date.

    This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.

    Default Value

    The current date.
    -

    Optional lastModDate

    lastModDate?: Date

    The last modification date.

    +

    Optional lastModDate

    lastModDate?: Date

    The last modification date.

    Default Value

    The current date.
    -

    Optional level

    level?: number

    The level of compression.

    +

    Optional level

    level?: number

    The level of compression.

    The minimum value is 0 and means that no compression is applied. The maximum value is 9.

    Default Value

    5
    -

    Optional msDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    +

    Optional msDosCompatible

    msDosCompatible?: boolean

    true to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.

    Default Value

    true
    -

    Optional password

    password?: string

    The password used to encrypt the content of the entry.

    -

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    +

    Optional password

    password?: string

    The password used to encrypt the content of the entry.

    +

    Optional preventClose

    preventClose?: boolean

    true to prevent closing of WritableWriter#writable.

    Default Value

    false
    -

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    -

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    -

    Optional supportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    +

    Optional rawPassword

    rawPassword?: Uint8Array

    The password used to encrypt the content of the entry (raw).

    +

    Optional signal

    signal?: AbortSignal

    The AbortSignal instance used to cancel the compression.

    +

    Optional supportZip64SplitFile

    supportZip64SplitFile?: boolean

    false to never write disk numbers in zip64 data.

    Default Value

    true
    -

    Optional usdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    +

    Optional usdz

    usdz?: boolean

    trueto produce zip files compatible with the USDZ specification.

    Default Value

    false
    -

    Optional version

    version?: number

    The "Version" field.

    -

    Optional versionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    +

    Optional version

    version?: number

    The "Version" field.

    +

    Optional versionMadeBy

    versionMadeBy?: number

    The "Version made by" field.

    Default Value

    20
    -

    Optional zip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    +

    Optional zip64

    zip64?: boolean

    true to use Zip64 to store the entry.

    zip64 is automatically set to true when necessary (e.g. compressed data larger than 4GB or with unknown size).

    Default Value

    false
    -

    Optional zipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    +

    Optional zipCrypto

    zipCrypto?: boolean

    true to use the ZipCrypto algorithm to encrypt the content of the entry.

    It is not recommended to set zipCrypto to true because the ZipCrypto encryption can be easily broken.

    Default Value

    false
    -

    Methods

    Optional encodeText

    • encodeText(text): Uint8Array

    • Encode the filename and the comment of the entry.

      +

    Methods

    Optional encodeText

    • encodeText(text): Uint8Array

    • Encode the filename and the comment of the entry.

      Parameters

      • text: string

        The text to encode.

        -

      Returns Uint8Array

      The encoded text.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    bufferedWritecreationDatedataDescriptordataDescriptorSignatureencryptionStrengthextendedTimestampexternalFileAttributeinternalFileAttributekeepOrderlastAccessDatelastModDatelevelmsDosCompatiblepasswordpreventCloserawPasswordsignalsupportZip64SplitFileusdzversionversionMadeByzip64zipCryptoencodeText
    \ No newline at end of file +

    Returns Uint8Array

    The encoded text or undefined if the text should be encoded by zip.js.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    bufferedWritecreationDatedataDescriptordataDescriptorSignatureencryptionStrengthextendedTimestampexternalFileAttributeinternalFileAttributekeepOrderlastAccessDatelastModDatelevelmsDosCompatiblepasswordpreventCloserawPasswordsignalsupportZip64SplitFileusdzversionversionMadeByzip64zipCryptoencodeText
    \ No newline at end of file diff --git a/api/interfaces/dataHandler.html b/api/interfaces/dataHandler.html index bd9e86ed..1538aef9 100644 --- a/api/interfaces/dataHandler.html +++ b/api/interfaces/dataHandler.html @@ -1,3 +1,3 @@ dataHandler | @zip.js/zip.js

    Interface dataHandler

    Represents the callback function used to handle data events.

    interface dataHandler ((data) => void)
    • dataHandler(data): void

    • Parameters

      • data: Uint8Array

        The processed chunk of data.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/interfaces/registerDataHandler.html b/api/interfaces/registerDataHandler.html index a59ad5a2..6064641a 100644 --- a/api/interfaces/registerDataHandler.html +++ b/api/interfaces/registerDataHandler.html @@ -1,4 +1,4 @@ registerDataHandler | @zip.js/zip.js

    Interface registerDataHandler

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

    interface registerDataHandler ((codec, onData) => void)

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_BAD_FORMAT.html b/api/variables/ERR_BAD_FORMAT.html index 32a593a2..4473459d 100644 --- a/api/variables/ERR_BAD_FORMAT.html +++ b/api/variables/ERR_BAD_FORMAT.html @@ -1,2 +1,2 @@ ERR_BAD_FORMAT | @zip.js/zip.js

    Variable ERR_BAD_FORMATConst

    ERR_BAD_FORMAT: string

    Zip format error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_CENTRAL_DIRECTORY_NOT_FOUND.html b/api/variables/ERR_CENTRAL_DIRECTORY_NOT_FOUND.html index 64716cac..9ccc46c0 100644 --- a/api/variables/ERR_CENTRAL_DIRECTORY_NOT_FOUND.html +++ b/api/variables/ERR_CENTRAL_DIRECTORY_NOT_FOUND.html @@ -1,2 +1,2 @@ ERR_CENTRAL_DIRECTORY_NOT_FOUND | @zip.js/zip.js

    Variable ERR_CENTRAL_DIRECTORY_NOT_FOUNDConst

    ERR_CENTRAL_DIRECTORY_NOT_FOUND: string

    Central Directory not found error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_DUPLICATED_NAME.html b/api/variables/ERR_DUPLICATED_NAME.html index c2658856..2179b076 100644 --- a/api/variables/ERR_DUPLICATED_NAME.html +++ b/api/variables/ERR_DUPLICATED_NAME.html @@ -1,2 +1,2 @@ ERR_DUPLICATED_NAME | @zip.js/zip.js

    Variable ERR_DUPLICATED_NAMEConst

    ERR_DUPLICATED_NAME: string

    Duplicate entry error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_ENCRYPTED.html b/api/variables/ERR_ENCRYPTED.html index 8f0b4190..245568a9 100644 --- a/api/variables/ERR_ENCRYPTED.html +++ b/api/variables/ERR_ENCRYPTED.html @@ -1,2 +1,2 @@ ERR_ENCRYPTED | @zip.js/zip.js

    Variable ERR_ENCRYPTEDConst

    ERR_ENCRYPTED: string

    Encrypted entry error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND.html b/api/variables/ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND.html index 9411ded5..8bc38e4d 100644 --- a/api/variables/ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND.html +++ b/api/variables/ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND.html @@ -1,2 +1,2 @@ ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND | @zip.js/zip.js

    Variable ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUNDConst

    ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND: string

    Zip64 End of Central Directory Locator not found error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_EOCDR_NOT_FOUND.html b/api/variables/ERR_EOCDR_NOT_FOUND.html index 14c3021e..8f167c6a 100644 --- a/api/variables/ERR_EOCDR_NOT_FOUND.html +++ b/api/variables/ERR_EOCDR_NOT_FOUND.html @@ -1,2 +1,2 @@ ERR_EOCDR_NOT_FOUND | @zip.js/zip.js

    Variable ERR_EOCDR_NOT_FOUNDConst

    ERR_EOCDR_NOT_FOUND: string

    End of Central Directory Record not found error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_EXTRAFIELD_ZIP64_NOT_FOUND.html b/api/variables/ERR_EXTRAFIELD_ZIP64_NOT_FOUND.html index 1f07ad1b..edf6a116 100644 --- a/api/variables/ERR_EXTRAFIELD_ZIP64_NOT_FOUND.html +++ b/api/variables/ERR_EXTRAFIELD_ZIP64_NOT_FOUND.html @@ -1,2 +1,2 @@ ERR_EXTRAFIELD_ZIP64_NOT_FOUND | @zip.js/zip.js

    Variable ERR_EXTRAFIELD_ZIP64_NOT_FOUNDConst

    ERR_EXTRAFIELD_ZIP64_NOT_FOUND: string

    Extra field Zip64 not found error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_HTTP_RANGE.html b/api/variables/ERR_HTTP_RANGE.html index 2376b583..ec7ffa03 100644 --- a/api/variables/ERR_HTTP_RANGE.html +++ b/api/variables/ERR_HTTP_RANGE.html @@ -1,2 +1,2 @@ ERR_HTTP_RANGE | @zip.js/zip.js

    Variable ERR_HTTP_RANGEConst

    ERR_HTTP_RANGE: string

    HTTP range error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_INVALID_COMMENT.html b/api/variables/ERR_INVALID_COMMENT.html index 16af5b6c..29771056 100644 --- a/api/variables/ERR_INVALID_COMMENT.html +++ b/api/variables/ERR_INVALID_COMMENT.html @@ -1,2 +1,2 @@ ERR_INVALID_COMMENT | @zip.js/zip.js

    Variable ERR_INVALID_COMMENTConst

    ERR_INVALID_COMMENT: string

    Invalid comment error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_INVALID_ENCRYPTION_STRENGTH.html b/api/variables/ERR_INVALID_ENCRYPTION_STRENGTH.html index 49ca11be..bf66c8a0 100644 --- a/api/variables/ERR_INVALID_ENCRYPTION_STRENGTH.html +++ b/api/variables/ERR_INVALID_ENCRYPTION_STRENGTH.html @@ -1,2 +1,2 @@ ERR_INVALID_ENCRYPTION_STRENGTH | @zip.js/zip.js

    Variable ERR_INVALID_ENCRYPTION_STRENGTHConst

    ERR_INVALID_ENCRYPTION_STRENGTH: string

    Invalid encryption strength error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_INVALID_ENTRY_COMMENT.html b/api/variables/ERR_INVALID_ENTRY_COMMENT.html index 6010b0f3..23cea77f 100644 --- a/api/variables/ERR_INVALID_ENTRY_COMMENT.html +++ b/api/variables/ERR_INVALID_ENTRY_COMMENT.html @@ -1,2 +1,2 @@ ERR_INVALID_ENTRY_COMMENT | @zip.js/zip.js

    Variable ERR_INVALID_ENTRY_COMMENTConst

    ERR_INVALID_ENTRY_COMMENT: string

    Invalid entry comment error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_INVALID_ENTRY_NAME.html b/api/variables/ERR_INVALID_ENTRY_NAME.html index c2b019d5..ec1dcdc4 100644 --- a/api/variables/ERR_INVALID_ENTRY_NAME.html +++ b/api/variables/ERR_INVALID_ENTRY_NAME.html @@ -1,2 +1,2 @@ ERR_INVALID_ENTRY_NAME | @zip.js/zip.js

    Variable ERR_INVALID_ENTRY_NAMEConst

    ERR_INVALID_ENTRY_NAME: string

    Invalid entry name error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_INVALID_EXTRAFIELD_DATA.html b/api/variables/ERR_INVALID_EXTRAFIELD_DATA.html index d7333421..7f03f30c 100644 --- a/api/variables/ERR_INVALID_EXTRAFIELD_DATA.html +++ b/api/variables/ERR_INVALID_EXTRAFIELD_DATA.html @@ -1,2 +1,2 @@ ERR_INVALID_EXTRAFIELD_DATA | @zip.js/zip.js

    Variable ERR_INVALID_EXTRAFIELD_DATAConst

    ERR_INVALID_EXTRAFIELD_DATA: string

    Invalid extra field data error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_INVALID_EXTRAFIELD_TYPE.html b/api/variables/ERR_INVALID_EXTRAFIELD_TYPE.html index b6a455ac..62b41b45 100644 --- a/api/variables/ERR_INVALID_EXTRAFIELD_TYPE.html +++ b/api/variables/ERR_INVALID_EXTRAFIELD_TYPE.html @@ -1,2 +1,2 @@ ERR_INVALID_EXTRAFIELD_TYPE | @zip.js/zip.js

    Variable ERR_INVALID_EXTRAFIELD_TYPEConst

    ERR_INVALID_EXTRAFIELD_TYPE: string

    Invalid extra field type error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_INVALID_PASSWORD.html b/api/variables/ERR_INVALID_PASSWORD.html index e517ed27..c43ef480 100644 --- a/api/variables/ERR_INVALID_PASSWORD.html +++ b/api/variables/ERR_INVALID_PASSWORD.html @@ -1,2 +1,2 @@ ERR_INVALID_PASSWORD | @zip.js/zip.js

    Variable ERR_INVALID_PASSWORDConst

    ERR_INVALID_PASSWORD: string

    Invalid password error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_INVALID_SIGNATURE.html b/api/variables/ERR_INVALID_SIGNATURE.html index fd44792c..3b95cc8e 100644 --- a/api/variables/ERR_INVALID_SIGNATURE.html +++ b/api/variables/ERR_INVALID_SIGNATURE.html @@ -1,2 +1,2 @@ ERR_INVALID_SIGNATURE | @zip.js/zip.js

    Variable ERR_INVALID_SIGNATUREConst

    ERR_INVALID_SIGNATURE: string

    Invalid signature error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_INVALID_VERSION.html b/api/variables/ERR_INVALID_VERSION.html index db172576..0b0675e6 100644 --- a/api/variables/ERR_INVALID_VERSION.html +++ b/api/variables/ERR_INVALID_VERSION.html @@ -1,2 +1,2 @@ ERR_INVALID_VERSION | @zip.js/zip.js

    Variable ERR_INVALID_VERSIONConst

    ERR_INVALID_VERSION: string

    Invalid version error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_ITERATOR_COMPLETED_TOO_SOON.html b/api/variables/ERR_ITERATOR_COMPLETED_TOO_SOON.html index 6ae74869..219880fe 100644 --- a/api/variables/ERR_ITERATOR_COMPLETED_TOO_SOON.html +++ b/api/variables/ERR_ITERATOR_COMPLETED_TOO_SOON.html @@ -1,2 +1,2 @@ ERR_ITERATOR_COMPLETED_TOO_SOON | @zip.js/zip.js

    Variable ERR_ITERATOR_COMPLETED_TOO_SOONConst

    ERR_ITERATOR_COMPLETED_TOO_SOON: string

    Iteration completed too soon error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_LOCAL_FILE_HEADER_NOT_FOUND.html b/api/variables/ERR_LOCAL_FILE_HEADER_NOT_FOUND.html index 5e6a4fb5..15c29dcb 100644 --- a/api/variables/ERR_LOCAL_FILE_HEADER_NOT_FOUND.html +++ b/api/variables/ERR_LOCAL_FILE_HEADER_NOT_FOUND.html @@ -1,2 +1,2 @@ ERR_LOCAL_FILE_HEADER_NOT_FOUND | @zip.js/zip.js

    Variable ERR_LOCAL_FILE_HEADER_NOT_FOUNDConst

    ERR_LOCAL_FILE_HEADER_NOT_FOUND: string

    Local file header not found error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_SPLIT_ZIP_FILE.html b/api/variables/ERR_SPLIT_ZIP_FILE.html index 9a1d124c..001e2c06 100644 --- a/api/variables/ERR_SPLIT_ZIP_FILE.html +++ b/api/variables/ERR_SPLIT_ZIP_FILE.html @@ -1,2 +1,2 @@ ERR_SPLIT_ZIP_FILE | @zip.js/zip.js

    Variable ERR_SPLIT_ZIP_FILEConst

    ERR_SPLIT_ZIP_FILE: string

    Split zip file error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_UNSUPPORTED_COMPRESSION.html b/api/variables/ERR_UNSUPPORTED_COMPRESSION.html index ed5c7636..044d6406 100644 --- a/api/variables/ERR_UNSUPPORTED_COMPRESSION.html +++ b/api/variables/ERR_UNSUPPORTED_COMPRESSION.html @@ -1,2 +1,2 @@ ERR_UNSUPPORTED_COMPRESSION | @zip.js/zip.js

    Variable ERR_UNSUPPORTED_COMPRESSIONConst

    ERR_UNSUPPORTED_COMPRESSION: string

    Unsupported compression error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_UNSUPPORTED_ENCRYPTION.html b/api/variables/ERR_UNSUPPORTED_ENCRYPTION.html index 7c431667..8914f814 100644 --- a/api/variables/ERR_UNSUPPORTED_ENCRYPTION.html +++ b/api/variables/ERR_UNSUPPORTED_ENCRYPTION.html @@ -1,2 +1,2 @@ ERR_UNSUPPORTED_ENCRYPTION | @zip.js/zip.js

    Variable ERR_UNSUPPORTED_ENCRYPTIONConst

    ERR_UNSUPPORTED_ENCRYPTION: string

    Unsupported encryption error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/ERR_UNSUPPORTED_FORMAT.html b/api/variables/ERR_UNSUPPORTED_FORMAT.html index 88d61d6e..2abb036a 100644 --- a/api/variables/ERR_UNSUPPORTED_FORMAT.html +++ b/api/variables/ERR_UNSUPPORTED_FORMAT.html @@ -1,2 +1,2 @@ ERR_UNSUPPORTED_FORMAT | @zip.js/zip.js

    Variable ERR_UNSUPPORTED_FORMATConst

    ERR_UNSUPPORTED_FORMAT: string

    Invalid format error

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/api/variables/fs-1.html b/api/variables/fs-1.html index 43651a39..afa4b64f 100644 --- a/api/variables/fs-1.html +++ b/api/variables/fs-1.html @@ -8,4 +8,4 @@
  • ZipFileEntry: typeof ZipFileEntry

    The ZipFileEntry constructor.

    Default Value

    {@link ZipFileEntry}
    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file