Creates the Reader instance
+Represents a Reader instance used to read data provided as a Blob instance.
Creates the Reader instance
The data to read.
-The ReadableStream instance.
The total size of the data in bytes.
-Optional initThe ReadableStream instance.
The total size of the data in bytes.
+Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents a WritableWriter instance used to retrieve the written data as a Blob instance.
Creates the BlobWriter instance
+Represents a WritableWriter instance used to retrieve the written data as a Blob instance.
Creates the BlobWriter instance
Optional mimeString: stringThe MIME type of the content.
-The WritableStream instance.
The WritableStream instance.
Generated using TypeDoc
Generated using TypeDoc
Represents a class implementing CompressionStream or DecompressionStream interfaces.
Optional transformer: Transformer<any, any>Optional writableStrategy: QueuingStrategy<any>Optional readableStrategy: QueuingStrategy<any>Readonly readableReadonly writableGenerated using TypeDoc
Represents a class implementing CompressionStream or DecompressionStream interfaces.
Optional transformer: Transformer<any, any>Optional writableStrategy: QueuingStrategy<any>Optional readableStrategy: QueuingStrategy<any>Readonly readableReadonly writableGenerated using TypeDoc
Represents a Reader instance used to read data provided as a Data URI string encoded in Base64.
Creates the Reader instance
+Represents a Reader instance used to read data provided as a Data URI string encoded in Base64.
Creates the Reader instance
The data to read.
-The ReadableStream instance.
The total size of the data in bytes.
-Optional initThe ReadableStream instance.
The total size of the data in bytes.
+Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents a Writer instance used to retrieve the written data as a Data URI string encoded in Base64.
Creates the Data64URIWriter instance
+Represents a Writer instance used to retrieve the written data as a Data URI string encoded in Base64.
Creates the Data64URIWriter instance
Optional mimeString: stringThe MIME type of the content.
-The WritableStream instance.
The WritableStream instance.
Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents an event-based implementation of a third-party codec.
-The function called when a chunk of data has been compressed/decompressed.
+Represents an event-based implementation of a third-party codec.
+Generated using TypeDoc
Generated using TypeDoc
Represents a Filesystem instance.
+Represents a Filesystem instance.
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));
The children of the entry.
-Optional dataThe underlying EntryMetaData instance.
-true for ZipDirectoryEntry instances.
The ID of the instance.
-The relative filename of the entry.
-Optional parentThe parent directory of the entry.
-The root directory.
-The uncompressed size of the content.
-Adds a entry entry with content provided as a Blob instance
The children of the entry.
+Optional dataThe underlying EntryMetaData instance.
+true for ZipDirectoryEntry instances.
The ID of the instance.
+The relative filename of the entry.
+Optional parentThe parent directory of the entry.
+The root directory.
+The uncompressed size of the content.
+Adds a entry entry with content provided as a Blob instance
The relative filename of the entry.
The Blob instance.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Adds a entry entry with content provided as a Data URI string encoded in Base64
Adds a entry entry with content provided as a Data URI string encoded in Base64
The relative filename of the entry.
The Data URI string encoded in Base64.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Adds a directory
+Adds a directory
The relative filename of the directory.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipDirectoryEntry instance.
-Adds an entry with content provided via a File instance
Adds an entry with content provided via a File instance
The File instance.
Optional options: ZipWriterAddDataOptionsThe options.
A promise resolving to a ZipFileEntry or a ZipDirectoryEntry instance.
-Adds an entry with content provided via a FileSystemEntry instance
The FileSystemEntry instance.
Adds an entry with content provided via a FileSystemEntry instance
The FileSystemEntry instance.
Optional options: ZipWriterAddDataOptionsThe options.
A promise resolving to an array of ZipFileEntry or a ZipDirectoryEntry instances.
-Adds an entry with content provided via a FileSystemHandle instance
The fileSystemHandle instance.
Adds an entry with content provided via a FileSystemHandle instance
The fileSystemHandle instance.
Optional options: ZipWriterAddDataOptionsThe options.
A promise resolving to an array of ZipFileEntry or a ZipDirectoryEntry instances.
-Adds an entry with content fetched from a URL
+Adds an entry with content fetched from a URL
The relative filename of the entry.
The URL.
Optional options: HttpOptions & ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Adds a entry entry with content provided via a ReadableStream instance
Adds a entry entry with content provided via a ReadableStream instance
The relative filename of the entry.
The ReadableStream instance.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Adds an entry with content provided as text
+Adds an entry with content provided as text
The relative filename of the entry.
The text.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Adds an entry with content provided as a Uint8Array instance
Adds an entry with content provided as a Uint8Array instance
The relative filename of the entry.
The Uint8Array instance.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Tests the password on the entry and all children if any, returns true if the entry is not password protected
Optional options: EntryGetDataOptionsClones the entry
+Tests the password on the entry and all children if any, returns true if the entry is not password protected
Optional options: EntryGetDataOptionsReturns a Blob instance containing a zip file of the entry and its descendants
Optional options: ZipDirectoryEntryExportOptionsThe options.
A promise resolving to the Blob instance.
Returns a Data URI string encoded in Base64 containing a zip file of the entry and its descendants
Returns a Data URI string encoded in Base64 containing a zip file of the entry and its descendants
Optional options: ZipDirectoryEntryExportOptionsThe options.
A promise resolving to the Data URI string encoded in Base64.
Returns a Uint8Array instance containing a zip file of the entry and its descendants
Returns a Uint8Array instance containing a zip file of the entry and its descendants
Optional options: ZipDirectoryEntryExportOptionsThe options.
A promise resolving to the Uint8Array instance.
Creates a zip file via a WritableStream instance containing the entry and its descendants
Creates a zip file via a WritableStream instance containing the entry and its descendants
Optional writable: WritableStream<any>The WritableStream instance.
Optional options: ZipDirectoryEntryExportOptionsThe options.
A promise resolving to the Uint8Array instance.
Creates a zip file via a custom Writer instance containing the entry and its descendants
+Creates a zip file via a custom Writer instance containing the entry and its descendants
The Writer instance.
Optional options: ZipDirectoryEntryExportOptionsThe options.
A promise resolving to the data.
-Returns a ZipEntry instance from its full filename
+Returns a ZipEntry instance from the value of ZipEntry#id
+Gets a ZipEntry child instance from its relative filename
+Gets a ZipEntry child instance from its relative filename
The relative filename.
A ZipFileEntry or a ZipDirectoryEntry instance (use the ZipFileEntry#directory and ZipDirectoryEntry#directory properties to differentiate entries).
-Returns the filename of the entry relative to a parent directory
-Extracts a zip file provided as a Blob instance into the entry
Returns the filename of the entry relative to a parent directory
+Extracts a zip file provided as a Blob instance into the entry
The Blob instance.
Optional options: ZipReaderConstructorOptionsThe options.
-Extracts a zip file provided as a Data URI string encoded in Base64 into the entry
Extracts a zip file provided as a Data URI string encoded in Base64 into the entry
The Data URI string encoded in Base64.
Optional options: ZipReaderConstructorOptionsThe options.
-Extracts a zip file fetched from a URL into the entry
+Extracts a zip file fetched from a URL into the entry
The URL.
Optional options: ZipDirectoryEntryImportHttpOptionsThe options.
-Extracts a zip file provided via a ReadableStream instance into the entry
Extracts a zip file provided via a ReadableStream instance into the entry
The ReadableStream instance.
Optional options: ZipReaderConstructorOptionsThe options.
-Extracts a zip file provided as a Uint8Array instance into the entry
Extracts a zip file provided as a Uint8Array instance into the entry
The Uint8Array instance.
Optional options: ZipReaderConstructorOptionsThe options.
-Extracts a zip file provided via a custom Reader instance into the entry
The Reader instance.
Optional options: ZipReaderConstructorOptionsThe options.
-Tests if a ZipDirectoryEntry instance is an ancestor of the entry
+Tests if a ZipDirectoryEntry instance is an ancestor of the entry
The ZipDirectoryEntry instance.
-Moves a ZipEntry instance and its children into a ZipDirectoryEntry instance
+Moves a ZipEntry instance and its children into a ZipDirectoryEntry instance
The ZipEntry instance to move.
The ZipDirectoryEntry instance.
-Removes a ZipEntry instance and its children
+Removes a ZipEntry instance and its children
Generated using TypeDoc
Generated using TypeDoc
Represents a generic TransformStream class.
Generated using TypeDoc
Represents a Reader instance used to fetch data from servers returning Accept-Ranges headers.
Creates the HttpRangeReader instance
+Represents a Reader instance used to fetch data from servers returning Accept-Ranges headers.
Creates the HttpRangeReader instance
The URL of the data.
Optional options: HttpRangeOptionsThe options.
-The ReadableStream instance.
The total size of the data in bytes.
-Optional initThe ReadableStream instance.
The total size of the data in bytes.
+Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents a Reader instance used to fetch data from a URL.
-Creates the HttpReader instance
+Represents a Reader instance used to fetch data from a URL.
+Creates the HttpReader instance
The URL of the data.
Optional options: HttpOptionsThe options.
-The ReadableStream instance.
The total size of the data in bytes.
-Optional initThe ReadableStream instance.
The total size of the data in bytes.
+Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents an instance used to read unknown type of data.
+Represents an instance used to read unknown type of data.
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;
}
}
The ReadableStream instance.
The total size of the data in bytes.
-Optional initThe ReadableStream instance.
The total size of the data in bytes.
+Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents a Reader instance used to read data provided as an array of ReadableReader instances (e.g. split zip files).
-Creates the Reader instance
+Represents a Reader instance used to read data provided as an array of ReadableReader instances (e.g. split zip files).
+Creates the Reader instance
The data to read.
-The ReadableStream instance.
The total size of the data in bytes.
-Optional initThe ReadableStream instance.
The total size of the data in bytes.
+Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents a Writer instance used to retrieve the written data from a generator of WritableWriter instances (i.e. split zip files).
-Creates the SplitDataWriter instance
+Represents a Writer instance used to retrieve the written data from a generator of WritableWriter instances (i.e. split zip files).
+Creates the SplitDataWriter instance
A generator of Writer instances.
Optional maxSize: numberThe maximum size of the data written into Writer instances (default: 4GB).
-The WritableStream instance.
Generated using TypeDoc
The WritableStream instance.
Generated using TypeDoc
Represents a Reader instance used to read data provided as an array of ReadableReader instances (e.g. split zip files).
+Represents a Reader instance used to read data provided as an array of ReadableReader instances (e.g. split zip files).
Use SplitDataReader instead.
-Creates the Reader instance
+Creates the Reader instance
The data to read.
-The ReadableStream instance.
The total size of the data in bytes.
-Optional initThe ReadableStream instance.
The total size of the data in bytes.
+Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents a Writer instance used to retrieve the written data from a generator of WritableWriter instances (i.e. split zip files).
+Represents a Writer instance used to retrieve the written data from a generator of WritableWriter instances (i.e. split zip files).
Use SplitDataWriter instead.
-Creates the SplitDataWriter instance
+Creates the SplitDataWriter instance
A generator of Writer instances.
Optional maxSize: numberThe maximum size of the data written into Writer instances (default: 4GB).
-The WritableStream instance.
Generated using TypeDoc
The WritableStream instance.
Generated using TypeDoc
Generated using TypeDoc
Represents a Reader instance used to read data provided as a string.
Creates the Reader instance
+Represents a Reader instance used to read data provided as a string.
Creates the Reader instance
The data to read.
-The ReadableStream instance.
The total size of the data in bytes.
-Optional initThe ReadableStream instance.
The total size of the data in bytes.
+Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents a Writer instance used to retrieve the written data as a string.
Creates the TextWriter instance
+Represents a Writer instance used to retrieve the written data as a string.
Creates the TextWriter instance
Optional encoding: stringThe encoding of the text.
-The WritableStream instance.
The WritableStream instance.
Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents a generic TransformStream class.
The readable stream.
+The writable stream.
+Generated using TypeDoc
Represents a Reader instance used to read data provided as a Uint8Array instance.
Creates the Reader instance
+Represents a Reader instance used to read data provided as a Uint8Array instance.
Creates the Reader instance
The data to read.
-The ReadableStream instance.
The total size of the data in bytes.
-Optional initThe ReadableStream instance.
The total size of the data in bytes.
+Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents a Writer instance used to retrieve the written data as a Uint8Array instance.
The WritableStream instance.
Retrieves all the written data
+Represents a Writer instance used to retrieve the written data as a Uint8Array instance.
The WritableStream instance.
Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents an instance used to write unknown type of data.
+Represents an instance used to write unknown type of data.
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;
}
}
The WritableStream instance.
Retrieves all the written data
+The WritableStream instance.
Optional initGenerated using TypeDoc
Generated using TypeDoc
Represents an instance used to compress data.
-Appends a chunk of decompressed data to compress
+Represents an instance used to compress data.
+Generated using TypeDoc
Generated using TypeDoc
Represents a directory entry in the zip (Filesystem API).
-The children of the entry.
-Optional dataThe underlying EntryMetaData instance.
-true for ZipDirectoryEntry instances.
The ID of the instance.
-The relative filename of the entry.
-Optional parentThe parent directory of the entry.
-The uncompressed size of the content.
-Adds a entry entry with content provided as a Blob instance
Represents a directory entry in the zip (Filesystem API).
+The children of the entry.
+Optional dataThe underlying EntryMetaData instance.
+true for ZipDirectoryEntry instances.
The ID of the instance.
+The relative filename of the entry.
+Optional parentThe parent directory of the entry.
+The uncompressed size of the content.
+Adds a entry entry with content provided as a Blob instance
The relative filename of the entry.
The Blob instance.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Adds a entry entry with content provided as a Data URI string encoded in Base64
Adds a entry entry with content provided as a Data URI string encoded in Base64
The relative filename of the entry.
The Data URI string encoded in Base64.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Adds a directory
+Adds a directory
The relative filename of the directory.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipDirectoryEntry instance.
-Adds an entry with content provided via a File instance
Adds an entry with content provided via a File instance
The File instance.
Optional options: ZipWriterAddDataOptionsThe options.
A promise resolving to a ZipFileEntry or a ZipDirectoryEntry instance.
-Adds an entry with content provided via a FileSystemEntry instance
The FileSystemEntry instance.
Adds an entry with content provided via a FileSystemEntry instance
The FileSystemEntry instance.
Optional options: ZipWriterAddDataOptionsThe options.
A promise resolving to an array of ZipFileEntry or a ZipDirectoryEntry instances.
-Adds an entry with content provided via a FileSystemHandle instance
The fileSystemHandle instance.
Adds an entry with content provided via a FileSystemHandle instance
The fileSystemHandle instance.
Optional options: ZipWriterAddDataOptionsThe options.
A promise resolving to an array of ZipFileEntry or a ZipDirectoryEntry instances.
-Adds an entry with content fetched from a URL
+Adds an entry with content fetched from a URL
The relative filename of the entry.
The URL.
Optional options: HttpOptions & ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Adds a entry entry with content provided via a ReadableStream instance
Adds a entry entry with content provided via a ReadableStream instance
The relative filename of the entry.
The ReadableStream instance.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Adds an entry with content provided as text
+Adds an entry with content provided as text
The relative filename of the entry.
The text.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Adds an entry with content provided as a Uint8Array instance
Adds an entry with content provided as a Uint8Array instance
The relative filename of the entry.
The Uint8Array instance.
Optional options: ZipWriterAddDataOptionsThe options.
A ZipFileEntry instance.
-Tests the password on the entry and all children if any, returns true if the entry is not password protected
Optional options: EntryGetDataOptionsClones the entry
+Tests the password on the entry and all children if any, returns true if the entry is not password protected
Optional options: EntryGetDataOptionsReturns a Blob instance containing a zip file of the entry and its descendants
Optional options: ZipDirectoryEntryExportOptionsThe options.
A promise resolving to the Blob instance.
Returns a Data URI string encoded in Base64 containing a zip file of the entry and its descendants
Returns a Data URI string encoded in Base64 containing a zip file of the entry and its descendants
Optional options: ZipDirectoryEntryExportOptionsThe options.
A promise resolving to the Data URI string encoded in Base64.
Returns a Uint8Array instance containing a zip file of the entry and its descendants
Returns a Uint8Array instance containing a zip file of the entry and its descendants
Optional options: ZipDirectoryEntryExportOptionsThe options.
A promise resolving to the Uint8Array instance.
Creates a zip file via a WritableStream instance containing the entry and its descendants
Creates a zip file via a WritableStream instance containing the entry and its descendants
Optional writable: WritableStream<any>The WritableStream instance.
Optional options: ZipDirectoryEntryExportOptionsThe options.
A promise resolving to the Uint8Array instance.
Creates a zip file via a custom Writer instance containing the entry and its descendants
+Creates a zip file via a custom Writer instance containing the entry and its descendants
The Writer instance.
Optional options: ZipDirectoryEntryExportOptionsThe options.
A promise resolving to the data.
-Gets a ZipEntry child instance from its relative filename
+Gets a ZipEntry child instance from its relative filename
The relative filename.
A ZipFileEntry or a ZipDirectoryEntry instance (use the ZipFileEntry#directory and ZipDirectoryEntry#directory properties to differentiate entries).
-Returns the filename of the entry relative to a parent directory
-Extracts a zip file provided as a Blob instance into the entry
Returns the filename of the entry relative to a parent directory
+Extracts a zip file provided as a Blob instance into the entry
The Blob instance.
Optional options: ZipReaderConstructorOptionsThe options.
-Extracts a zip file provided as a Data URI string encoded in Base64 into the entry
Extracts a zip file provided as a Data URI string encoded in Base64 into the entry
The Data URI string encoded in Base64.
Optional options: ZipReaderConstructorOptionsThe options.
-Extracts a zip file fetched from a URL into the entry
+Extracts a zip file fetched from a URL into the entry
The URL.
Optional options: ZipDirectoryEntryImportHttpOptionsThe options.
-Extracts a zip file provided via a ReadableStream instance into the entry
Extracts a zip file provided via a ReadableStream instance into the entry
The ReadableStream instance.
Optional options: ZipReaderConstructorOptionsThe options.
-Extracts a zip file provided as a Uint8Array instance into the entry
Extracts a zip file provided as a Uint8Array instance into the entry
The Uint8Array instance.
Optional options: ZipReaderConstructorOptionsThe options.
-Extracts a zip file provided via a custom Reader instance into the entry
The Reader instance.
Optional options: ZipReaderConstructorOptionsThe options.
-Tests if a ZipDirectoryEntry instance is an ancestor of the entry
+Tests if a ZipDirectoryEntry instance is an ancestor of the entry
The ZipDirectoryEntry instance.
-Generated using TypeDoc
Generated using TypeDoc
Represents an entry in a zip file (Filesystem API).
-The children of the entry.
-Optional dataThe underlying EntryMetaData instance.
-The ID of the instance.
-The relative filename of the entry.
-Optional parentThe parent directory of the entry.
-The uncompressed size of the content.
-Tests the password on the entry and all children if any, returns true if the entry is not password protected
Optional options: EntryGetDataOptionsClones the entry
+Represents an entry in a zip file (Filesystem API).
+The children of the entry.
+Optional dataThe underlying EntryMetaData instance.
+The ID of the instance.
+The relative filename of the entry.
+Optional parentThe parent directory of the entry.
+The uncompressed size of the content.
+Tests the password on the entry and all children if any, returns true if the entry is not password protected
Optional options: EntryGetDataOptionsReturns the filename of the entry relative to a parent directory
-Tests if a ZipDirectoryEntry instance is an ancestor of the entry
+Returns the filename of the entry relative to a parent directory
+Tests if a ZipDirectoryEntry instance is an ancestor of the entry
The ZipDirectoryEntry instance.
-Generated using TypeDoc
Generated using TypeDoc
Represents a file entry in the zip (Filesystem API).
-The children of the entry.
-Optional dataThe underlying EntryMetaData instance.
-void for ZipFileEntry instances.
The ID of the instance.
-The relative filename of the entry.
-Optional parentThe parent directory of the entry.
-The Reader instance used to read the content of the entry.
-The uncompressed size of the content.
-The Writer instance used to write the content of the entry.
-Tests the password on the entry and all children if any, returns true if the entry is not password protected
Optional options: EntryGetDataOptionsClones the entry
+Represents a file entry in the zip (Filesystem API).
+The children of the entry.
+Optional dataThe underlying EntryMetaData instance.
+void for ZipFileEntry instances.
The ID of the instance.
+The relative filename of the entry.
+Optional parentThe parent directory of the entry.
+The Reader instance used to read the content of the entry.
+The uncompressed size of the content.
+The Writer instance used to write the content of the entry.
+Tests the password on the entry and all children if any, returns true if the entry is not password protected
Optional options: EntryGetDataOptionsRetrieves the content of the entry as a Blob instance
Optional mimeType: stringThe MIME type of the content.
Optional options: EntryGetDataOptionsThe options.
A promise resolving to a Blob instance.
Retrieves the content of the entry via a Writer instance
+Retrieves the content of the entry via a Writer instance
The Writer instance.
Optional options: EntryGetDataOptionsThe options.
A promise resolving to data associated to the Writer instance.
-Retrieves the content of the entry as as a Data URI string encoded in Base64
Retrieves the content of the entry as as a Data URI string encoded in Base64
Optional mimeType: stringThe MIME type of the content.
Optional options: EntryGetDataOptionsThe options.
A promise resolving to a Data URI string encoded in Base64.
Returns the filename of the entry relative to a parent directory
-Retrieves the text content of the entry as a string
Returns the filename of the entry relative to a parent directory
+Retrieves the text content of the entry as a string
Optional encoding: stringThe encoding of the text.
Optional options: EntryGetDataOptionsThe options.
A promise resolving to a string.
Retrieves the content of the entry as a Uint8Array instance
Retrieves the content of the entry as a Uint8Array instance
Optional options: EntryGetDataOptionsThe options.
A promise resolving to a Uint8Array instance.
Retrieves the content of the entry via a WritableStream instance
Retrieves the content of the entry via a WritableStream instance
Optional writable: WritableStream<any>The WritableStream instance.
Optional options: EntryGetDataOptionsThe options.
A promise resolving to the WritableStream instance.
Tests if a ZipDirectoryEntry instance is an ancestor of the entry
+Tests if a ZipDirectoryEntry instance is an ancestor of the entry
The ZipDirectoryEntry instance.
-Generated using TypeDoc
Generated using TypeDoc
Represents a codec used to decompress data.
-Appends a chunk of decompressed data to compress
+Represents a codec used to decompress data.
+Generated using TypeDoc
Generated using TypeDoc
Represents an instance used to read a zip file.
+Represents an instance used to read a zip file.
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();
Creates the instance
The Reader instance used to read data.
Optional options: ZipReaderConstructorOptionsThe options.
-Optional appendedThe data appended after the zip file.
-The global comment of the zip file.
-Optional prependedThe data prepended before the zip file.
-Returns all the entries in the zip file
+Optional appendedThe data appended after the zip file.
+The global comment of the zip file.
+Optional prependedThe data prepended before the zip file.
+Returns all the entries in the zip file
Optional options: ZipReaderGetEntriesOptionsThe options.
A promise resolving to an array of Entry instances.
Returns a generator used to iterate on all the entries in the zip file
+Returns a generator used to iterate on all the entries in the zip file
Optional options: ZipReaderGetEntriesOptionsThe options.
An asynchronous generator of Entry instances.
-Generated using TypeDoc
Generated using TypeDoc
Represents an instance used to create an unzipped stream.
+Represents an instance used to create an unzipped stream.
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)
}
Creates the stream.
+Creates the stream.
Optional options: ZipReaderConstructorOptionsThe options.
-The readable stream.
-The writable stream.
-Generated using TypeDoc
The readable stream.
+The writable stream.
+Generated using TypeDoc
Represents an instance used to create a zip file.
+Represents an instance used to create a zip file.
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();
Creates the ZipWriter instance
The Writer instance where the zip content will be written.
Optional options: ZipWriterConstructorOptionsThe options.
-Optional Readonly hastrue if the zip contains at least one entry that has been partially written.
Adds an entry into the zip file
+Optional Readonly hastrue if the zip contains at least one entry that has been partially written.
Adds an entry into the zip file
The filename of the entry.
Optional reader: ReadableStream<any> | ReadableReader | Reader<unknown>[] | ReadableReader[] | ReadableStream<any>[] | Reader<ReaderType>The Reader instance used to read the content of the entry.
Optional options: ZipWriterAddDataOptionsThe options.
A promise resolving to an EntryMetaData instance.
-Writes the entries directory, writes the global comment, and returns the content of the zip file
+Writes the entries directory, writes the global comment, and returns the content of the zip file
Optional comment: Uint8ArrayThe global comment of the zip file.
Optional options: ZipWriterCloseOptionsThe options.
The content of the zip file.
-Generated using TypeDoc
Generated using TypeDoc
Represents an instance used to create a zipped stream.
+Represents an instance used to create a zipped stream.
This example creates a zipped file called numbers.txt.zip containing the numbers 0 - 1000 each on their own line.
const readable = ReadableStream.from((function* () {
for (let i = 0; i < 1000; ++i)
yield i + '\n'
})())
readable
.pipeThrough(new ZipWriterStream().transform('numbers.txt'))
.pipeTo((await Deno.create('numbers.txt.zip')).writable)
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()
Creates the stream.
+Creates the stream.
Optional options: ZipWriterConstructorOptionsThe options.
-The readable stream.
-The ZipWriter property.
-The readable stream.
+The ZipWriter property.
+Writes the entries directory, writes the global comment, and returns the content of the zipped file.
Optional comment: Uint8ArrayThe global comment of the zip file.
Optional options: ZipWriterCloseOptionsThe options.
The content of the zip file.
-Returns an object containing a readable and writable property for the .pipeThrough method
+Returns an object containing a readable and writable property for the .pipeThrough method
The name of the stream when unzipped.
An object containing readable and writable properties
-Generated using TypeDoc
Generated using TypeDoc
Configures zip.js
+Configures zip.js
The configuration.
-Generated using TypeDoc
Generated using TypeDoc
Returns the MIME type corresponding to a filename extension.
+Generated using TypeDoc
Generated using TypeDoc
Transforms event-based third-party codec implementations into implementations compatible with zip.js
+Transforms event-based third-party codec implementations into implementations compatible with zip.js
The third-party codec implementations.
The options passed to the third-party implementations when building instances.
The function called to handle the data events triggered by a third-party codec implementation.
An instance containing classes compatible with ZipDeflate and ZipInflate.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
zip.js is a JavaScript open-source library (BSD-3-Clause license) for +
zip.js is a JavaScript open-source library (BSD-3-Clause license) for compressing and decompressing zip files. It has been designed to handle large amounts of data. It supports notably multi-core compression, native compression with compression streams, archives larger than 4GB with Zip64, split zip files and data @@ -15,4 +15,4 @@
Run the code on Plunker: https://plnkr.co/edit/4sVljNIpqSUE9HCA?preview
See https://github.com/gildas-lormeau/zip.js/tree/master/tests/all
-Generated using TypeDoc
Generated using TypeDoc
Represents the configuration passed to configure.
-Optional CompressionThe stream implementation used to compress data when useCompressionStream is set to false.
Represents the configuration passed to configure.
+Optional CompressionThe stream implementation used to compress data when useCompressionStream is set to false.
{@link CodecStream}
Optional DecompressionThe stream implementation used to decompress data when useCompressionStream is set to false.
Optional DecompressionThe stream implementation used to decompress data when useCompressionStream is set to false.
{@link CodecStream}
Optional DeflateThe codec implementation used to compress data.
+Optional DeflateThe codec implementation used to compress data.
{@link ZipDeflate}
Optional InflateThe codec implementation used to decompress data.
+Optional InflateThe codec implementation used to decompress data.
{@link ZipInflate}
Optional chunkThe size of the chunks in bytes during data compression/decompression.
+Optional chunkThe size of the chunks in bytes during data compression/decompression.
524288
Optional maxThe maximum number of web workers used to compress/decompress data simultaneously.
+Optional maxThe maximum number of web workers used to compress/decompress data simultaneously.
navigator.hardwareConcurrency
Optional terminateThe delay in milliseconds before idle web workers are automatically terminated. You can call terminateWorkers() to terminate idle workers.
Optional terminateThe delay in milliseconds before idle web workers are automatically terminated. You can call terminateWorkers() to terminate idle workers.
5000
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
true
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
true
Optional workerThe URIs of the compression/decompression scripts run in web workers.
+Optional workerThe 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 @@
Optional deflate?: string[]The URIs of the scripts implementing used for compression.
Optional inflate?: string[]The URIs of the scripts implementing used for decompression.
-Generated using TypeDoc
Generated using TypeDoc
Represents an entry with its data and metadata in a zip file (Core API).
-The comment of the entry.
-true if the comment is encoded in UTF-8.
The size of the compressed data in bytes.
-Optional creationThe creation date.
-true if the entry is a directory.
The number of the disk where the entry data starts.
-true if the content of the entry is encrypted.
The external file attribute (raw).
-Optional extraThe extra field.
-The filename of the entry.
-true if the filename is encoded in UTF-8.
The internal file attribute (raw).
-Optional lastThe last access date.
-The last modification date.
-true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.
The byte offset of the entry.
-The comment of the entry (raw).
-Optional rawThe creation date (raw).
-The extra field (raw).
-The filename of the entry (raw).
-Optional rawThe last access date (raw).
-The last modification date (raw).
-The signature (CRC32 checksum) of the content.
-The size of the decompressed data in bytes.
-The "Version" field.
-The "Version made by" field.
-true if the entry is using Zip64.
Optional getReturns the content of the entry
+Represents an entry with its data and metadata in a zip file (Core API).
+The comment of the entry.
+true if the comment is encoded in UTF-8.
The size of the compressed data in bytes.
+Optional creationThe creation date.
+true if the entry is a directory.
The number of the disk where the entry data starts.
+true if the content of the entry is encrypted.
The external file attribute (raw).
+Optional extraThe extra field.
+The filename of the entry.
+true if the filename is encoded in UTF-8.
The internal file attribute (raw).
+Optional lastThe last access date.
+The last modification date.
+true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.
The byte offset of the entry.
+The comment of the entry (raw).
+Optional rawThe creation date (raw).
+The extra field (raw).
+The filename of the entry (raw).
+Optional rawThe last access date (raw).
+The last modification date (raw).
+The signature (CRC32 checksum) of the content.
+The size of the decompressed data in bytes.
+The "Version" field.
+The "Version made by" field.
+true if the entry is using Zip64.
Optional getReturns the content of the entry
The Writer instance used to write the content of the entry.
Optional options: EntryGetDataOptionsThe options.
A promise resolving to the type to data associated to writer.
Tests if the password is valid.
+Tests if the password is valid.
undefined or null.
The options with checkPasswordOnly set to true.
Generated using TypeDoc
Generated using TypeDoc
Represents options passed to Entry#getData, ZipWriter.add and {@link ZipDirectory}.export*.
Optional onendThe function called when ending compression/decompression.
+Represents options passed to Entry#getData, ZipWriter.add and {@link ZipDirectory}.export*.
Optional onendOptional onprogressGenerated using TypeDoc
Generated using TypeDoc
Represents the options passed to Entry#getData and {@link ZipFileEntry}.get*.
true to check only if the password is valid.
Represents the options passed to Entry#getData and {@link ZipFileEntry}.get*.
true to check only if the password is valid.
false
Optional checktrue to check the signature of the entry.
Optional checktrue to check the signature of the entry.
false
Optional passwordThe password used to decrypt the content of the entry.
-Optional preventtrue to prevent closing of Writer#writable when calling Entry#getData.
Optional passwordThe password used to decrypt the content of the entry.
+Optional preventtrue to prevent closing of Writer#writable when calling Entry#getData.
false
Optional rawThe password used to encrypt the content of the entry (raw).
-Optional signalThe AbortSignal instance used to cancel the decompression.
Optional transfertrue to transfer streams to web workers when decompressing data.
Optional rawThe password used to encrypt the content of the entry (raw).
+Optional signalThe AbortSignal instance used to cancel the decompression.
Optional transfertrue to transfer streams to web workers when decompressing data.
true
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
true
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
true
Optional onendOptional onendOptional onprogressGenerated using TypeDoc
Generated using TypeDoc
Represents the options passed to Entry#getData and {@link ZipFileEntry}.get*.
Optional checktrue to check the signature of the entry.
Represents the options passed to Entry#getData and {@link ZipFileEntry}.get*.
Optional checktrue to check the signature of the entry.
false
Optional passwordThe password used to decrypt the content of the entry.
-Optional preventtrue to prevent closing of Writer#writable when calling Entry#getData.
Optional passwordThe password used to decrypt the content of the entry.
+Optional preventtrue to prevent closing of Writer#writable when calling Entry#getData.
false
Optional rawThe password used to encrypt the content of the entry (raw).
-Optional signalThe AbortSignal instance used to cancel the decompression.
Optional transfertrue to transfer streams to web workers when decompressing data.
Optional rawThe password used to encrypt the content of the entry (raw).
+Optional signalThe AbortSignal instance used to cancel the decompression.
Optional transfertrue to transfer streams to web workers when decompressing data.
true
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
true
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
true
Optional onendOptional onendOptional onprogressGenerated using TypeDoc
Generated using TypeDoc
Represents the metadata of an entry in a zip file (Core API).
-The comment of the entry.
-true if the comment is encoded in UTF-8.
The size of the compressed data in bytes.
-Optional creationThe creation date.
-true if the entry is a directory.
The number of the disk where the entry data starts.
-true if the content of the entry is encrypted.
The external file attribute (raw).
-Optional extraThe extra field.
-The filename of the entry.
-true if the filename is encoded in UTF-8.
The internal file attribute (raw).
-Optional lastThe last access date.
-The last modification date.
-true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.
The byte offset of the entry.
-The comment of the entry (raw).
-Optional rawThe creation date (raw).
-The extra field (raw).
-The filename of the entry (raw).
-Optional rawThe last access date (raw).
-The last modification date (raw).
-The signature (CRC32 checksum) of the content.
-The size of the decompressed data in bytes.
-The "Version" field.
-The "Version made by" field.
-true if the entry is using Zip64.
Generated using TypeDoc
Represents the metadata of an entry in a zip file (Core API).
+The comment of the entry.
+true if the comment is encoded in UTF-8.
The size of the compressed data in bytes.
+Optional creationThe creation date.
+true if the entry is a directory.
The number of the disk where the entry data starts.
+true if the content of the entry is encrypted.
The external file attribute (raw).
+Optional extraThe extra field.
+The filename of the entry.
+true if the filename is encoded in UTF-8.
The internal file attribute (raw).
+Optional lastThe last access date.
+The last modification date.
+true if internalFileAttribute and externalFileAttribute are compatible with MS-DOS format.
The byte offset of the entry.
+The comment of the entry (raw).
+Optional rawThe creation date (raw).
+The extra field (raw).
+The filename of the entry (raw).
+Optional rawThe last access date (raw).
+The last modification date (raw).
+The signature (CRC32 checksum) of the content.
+The size of the decompressed data in bytes.
+The "Version" field.
+The "Version made by" field.
+true if the entry is using Zip64.
Generated using TypeDoc
Represents options passed to ZipReader#getEntries, ZipReader#getEntriesGenerator, and ZipWriter#close.
-Optional onprogressThe function called each time an entry is read/written.
+Represents options passed to ZipReader#getEntries, ZipReader#getEntriesGenerator, and ZipWriter#close.
+Optional onprogressThe function called each time an entry is read/written.
The entry index.
The total number of entries.
The entry being read/written.
An empty promise or undefined.
Generated using TypeDoc
Generated using TypeDoc
Represents event-based implementations used to compress/decompress data.
-The class used to compress data.
-The class used to decompress data.
-Generated using TypeDoc
Represents event-based implementations used to compress/decompress data.
+The class used to compress data.
+The class used to decompress data.
+Generated using TypeDoc
Represents the FileSystemEntry class.
Generated using TypeDoc
Represents the FileSystemEntry class.
Generated using TypeDoc
Represents the FileSystemHandle class.
Generated using TypeDoc
Represents the FileSystemHandle class.
Generated using TypeDoc
Represents options passed to the constructor of ZipReader, ZipReader#getEntries and ZipReader#getEntriesGenerator.
-Optional commentThe encoding of the comment of the entry.
-Optional filenameThe encoding of the filename of the entry.
-Generated using TypeDoc
Represents options passed to the constructor of ZipReader, ZipReader#getEntries and ZipReader#getEntriesGenerator.
+Optional commentThe encoding of the comment of the entry.
+Optional filenameThe encoding of the filename of the entry.
+Generated using TypeDoc
Represents the options passed to the constructor of HttpReader.
-Optional forcetrue to always use Range headers when fetching data.
Represents the options passed to the constructor of HttpReader.
+Optional forcetrue to always use Range headers when fetching data.
false
Optional headersThe HTTP headers.
-Optional preventtrue to prevent using HEAD HTTP request in order the get the size of the content.
Optional headersThe HTTP headers.
+Optional preventtrue to prevent using HEAD HTTP request in order the get the size of the content.
false
Optional usetrue to use Range headers when fetching data from servers returning Accept-Ranges headers.
Optional usetrue to use Range headers when fetching data from servers returning Accept-Ranges headers.
false
Optional useXHRtrue to rely XMLHttpRequest instead of fetch to fetch data.
Optional useXHRtrue to rely XMLHttpRequest instead of fetch to fetch data.
false
Generated using TypeDoc
Generated using TypeDoc
Represents options passed to the constructor of HttpRangeReader and HttpReader.
-Optional headersThe HTTP headers.
-Optional useXHRtrue to rely XMLHttpRequest instead of fetch to fetch data.
Represents options passed to the constructor of HttpRangeReader and HttpReader.
+Optional headersThe HTTP headers.
+Optional useXHRtrue to rely XMLHttpRequest instead of fetch to fetch data.
false
Generated using TypeDoc
Generated using TypeDoc
Represents an instance used to read or write unknown type of data.
+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.
-Optional initGenerated using TypeDoc
Optional initGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Represents a URL stored into a string.
Readonly lengthReturns the length of a String object.
-Returns an <a> HTML anchor element and sets the name attribute to the text value
Represents a URL stored into a string.
Readonly lengthReturns the length of a String object.
+Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.
-Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false.
-Optional endPosition: numberReturns a <font> HTML element and sets the size attribute value
A legacy feature for browser compatibility
-Returns a <font> HTML element and sets the size attribute value
Returns a <font> HTML element and sets the size attribute value
A legacy feature for browser compatibility
-Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.
search string
Optional position: numberIf position is undefined, 0 is assumed, so as to search all of the String.
-Returns the position of the first occurrence of a substring.
The substring to search for in the string
Optional position: numberThe index at which to begin searching the String object. If omitted, search starts at the beginning of the string.
-Determines whether two strings are equivalent in the current or specified locale.
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: CollatorOptionsAn object that contains one or more properties that specify comparison options. see the Intl.Collator object for details.
-Matches a string with a regular expression, and returns an array containing the results of that search.
A variable name or string literal containing the regular expression pattern and flags.
-Matches a string or an object that supports being matched against, and returns an array +
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.
Matches a string with a regular expression, and returns an iterable of matches containing the results of that search.
A variable name or string literal containing the regular expression pattern and flags.
-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.
Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"
-Returns the String value result of normalizing the string into the normalization form +
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.
Optional form: stringApplicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"
-Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string.
The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
Optional fillString: stringThe string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).
-Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.
The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
Optional fillString: stringThe string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).
-Replaces text in a string, using a regular expression or search string.
A string or regular expression to search for.
A string containing the text to replace. When the searchValue is a RegExp, all matches are replaced if the g flag is set (or only those matches at the beginning, if the y flag is also present). Otherwise, only the first match of searchValue is replaced.
Replaces text in a string, using a regular expression or search string.
+Replaces text in a string, using a regular expression or search string.
A string to search for.
A function that returns the replacement text.
-Rest ...args: any[]Passes a string and replaceValue to the [Symbol.replace] method on searchValue. This method is expected to implement its own replacement algorithm.
Rest ...args: any[]Passes a string and replaceValue to the [Symbol.replace] method on searchValue. This method is expected to implement its own replacement algorithm.
Replaces text in a string, using an object that supports replacement within a string.
+Replaces text in a string, using an object that supports replacement within a string.
A object can search for and replace matches within a string.
A function that returns the replacement text.
-Rest ...args: any[]Finds the first substring match in a regular expression search.
Returns a section of a string.
Optional start: numberThe index to the beginning of the specified portion of stringObj.
Optional end: numberThe index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.
-Split a string into substrings using the specified separator and return them as an array.
A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.
Optional limit: numberA value used to limit the number of elements returned in the array.
-Split a string into substrings using the specified separator and return them as an array.
+Split a string into substrings using the specified separator and return them as an array.
Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false.
-Optional position: numberGets a substring beginning at the specified location and having the specified length.
The starting position of the desired substring. The index of the first character in the string is zero.
Optional length: numberThe number of characters to include in the returned substring.
A legacy feature for browser compatibility
-Returns the substring at the specified location within a String object.
The zero-based index number indicating the beginning of the substring.
Optional end: numberZero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.
-Generated using TypeDoc
Generated using TypeDoc
Represents configuration passed to configure, the constructor of ZipReader, Entry#getData, the constructor of ZipWriter, and ZipWriter#add.
-Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
Represents configuration passed to configure, the constructor of ZipReader, Entry#getData, the constructor of ZipWriter, and ZipWriter#add.
+Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
true
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
true
Generated using TypeDoc
Generated using TypeDoc
Represents an instance used to write data into a WritableStream instance.
Optional maxThe maximum size of split data when creating a ZipWriter instance or when calling Entry#getData with a generator of WritableWriter instances.
-The WritableStream instance.
Generated using TypeDoc
Represents an instance used to write data into a WritableStream instance.
Optional maxThe maximum size of split data when creating a ZipWriter instance or when calling Entry#getData with a generator of WritableWriter instances.
+The WritableStream instance.
Generated using TypeDoc
Represents the options passed to {@link ZipDirectoryEntry}#export*().
Optional bufferedtrue to write entry data in a buffer before appending it to the zip file.
Represents the options passed to {@link ZipDirectoryEntry}#export*().
Optional bufferedtrue to write entry data in a buffer before appending it to the zip file.
bufferedWrite is automatically set to true when compressing more than one entry in parallel.
false
Optional creationThe creation date.
+Optional creationThe creation date.
This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.
The current date.
Optional datatrue to to add a data descriptor.
Optional datatrue to to add a data descriptor.
When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.
true
Optional datatrue to add the signature of the data descriptor.
Optional datatrue to add the signature of the data descriptor.
false
Optional encryptionThe encryption strength (AES).
+Optional encryptionThe encryption strength (AES).
3
Optional extendedtrue to store extended timestamp extra fields.
Optional extendedtrue 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.
true
Optional externalThe external file attribute.
+Optional externalThe external file attribute.
0
Optional internalThe internal file attribute.
+Optional internalThe internal file attribute.
0
Optional keeptrue to keep the order of the entry physically in the zip file.
Optional keeptrue 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.
Another solution to improve the use of web workers is to add entries from smallest to largest in uncompressed size.
true
Optional lastThe last access date.
+Optional lastThe last access date.
This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.
The current date.
Optional lastThe last modification date.
+Optional lastThe last modification date.
The current date.
Optional levelThe level of compression.
+Optional levelThe level of compression.
The minimum value is 0 and means that no compression is applied. The maximum value is 9.
5
Optional mimeThe MIME type of the exported data when relevant.
-Optional mstrue to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.
Optional mimeThe MIME type of the exported data when relevant.
+Optional mstrue to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.
true
Optional passwordThe password used to encrypt the content of the entry.
-Optional preventtrue to prevent closing of WritableWriter#writable.
Optional passwordThe password used to encrypt the content of the entry.
+Optional preventtrue to prevent closing of WritableWriter#writable.
false
Optional rawThe password used to encrypt the content of the entry (raw).
-Optional readerThe options passed to the Reader instances
-Optional relativetrue to use filenames relative to the entry instead of full filenames.
Optional signalThe AbortSignal instance used to cancel the compression.
Optional supportfalse to never write disk numbers in zip64 data.
Optional rawThe password used to encrypt the content of the entry (raw).
+Optional readerThe options passed to the Reader instances
+Optional relativetrue to use filenames relative to the entry instead of full filenames.
Optional signalThe AbortSignal instance used to cancel the compression.
Optional supportfalse to never write disk numbers in zip64 data.
true
Optional usdztrueto produce zip files compatible with the USDZ specification.
Optional usdztrueto produce zip files compatible with the USDZ specification.
false
Optional versionThe "Version" field.
-Optional versionThe "Version made by" field.
+Optional versionThe "Version" field.
+Optional versionThe "Version made by" field.
20
Optional zip64true to use Zip64 to store the entry.
Optional zip64true 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).
false
Optional ziptrue to use the ZipCrypto algorithm to encrypt the content of the entry.
Optional ziptrue 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.
false
Optional onendOptional onendOptional onprogressGenerated using TypeDoc
Generated using TypeDoc
Represents the options passed to ZipDirectoryEntry#importHttpContent.
-Optional checktrue to check the signature of the entry.
Represents the options passed to ZipDirectoryEntry#importHttpContent.
+Optional checktrue to check the signature of the entry.
false
Optional commentThe encoding of the comment of the entry.
-Optional extracttrue to extract the appended data into ZipReader#appendedData.
Optional commentThe encoding of the comment of the entry.
+Optional extracttrue to extract the appended data into ZipReader#appendedData.
false
Optional extracttrue to extract the prepended data into ZipReader#prependedData.
Optional extracttrue to extract the prepended data into ZipReader#prependedData.
false
Optional filenameThe encoding of the filename of the entry.
-Optional forcetrue to always use Range headers when fetching data.
Optional filenameThe encoding of the filename of the entry.
+Optional forcetrue to always use Range headers when fetching data.
false
Optional headersThe HTTP headers.
-Optional passwordThe password used to decrypt the content of the entry.
-Optional preventtrue to prevent closing of Writer#writable when calling Entry#getData.
Optional headersThe HTTP headers.
+Optional passwordThe password used to decrypt the content of the entry.
+Optional preventtrue to prevent closing of Writer#writable when calling Entry#getData.
false
Optional preventtrue to prevent using HEAD HTTP request in order the get the size of the content.
Optional preventtrue to prevent using HEAD HTTP request in order the get the size of the content.
false
Optional rawThe password used to encrypt the content of the entry (raw).
-Optional signalThe AbortSignal instance used to cancel the decompression.
Optional transfertrue to transfer streams to web workers when decompressing data.
Optional rawThe password used to encrypt the content of the entry (raw).
+Optional signalThe AbortSignal instance used to cancel the decompression.
Optional transfertrue to transfer streams to web workers when decompressing data.
true
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
true
Optional usetrue to use Range headers when fetching data from servers returning Accept-Ranges headers.
Optional usetrue to use Range headers when fetching data from servers returning Accept-Ranges headers.
false
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
true
Optional useXHRtrue to rely XMLHttpRequest instead of fetch to fetch data.
Optional useXHRtrue to rely XMLHttpRequest instead of fetch to fetch data.
false
Generated using TypeDoc
Generated using TypeDoc
Represents the implementations zip.js uses to compress/decompress data.
-The class used to compress data.
+Generated using TypeDoc
Generated using TypeDoc
Represents options passed to the constructor of ZipReader and Entry#getData.
-true to check only if the password is valid.
Represents options passed to the constructor of ZipReader and Entry#getData.
+true to check only if the password is valid.
false
Generated using TypeDoc
Generated using TypeDoc
Represents the options passed to the constructor of ZipReader, and {@link ZipDirectory}#import*.
Optional checktrue to check the signature of the entry.
Represents the options passed to the constructor of ZipReader, and {@link ZipDirectory}#import*.
Optional checktrue to check the signature of the entry.
false
Optional commentThe encoding of the comment of the entry.
-Optional extracttrue to extract the appended data into ZipReader#appendedData.
Optional commentThe encoding of the comment of the entry.
+Optional extracttrue to extract the appended data into ZipReader#appendedData.
false
Optional extracttrue to extract the prepended data into ZipReader#prependedData.
Optional extracttrue to extract the prepended data into ZipReader#prependedData.
false
Optional filenameThe encoding of the filename of the entry.
-Optional passwordThe password used to decrypt the content of the entry.
-Optional preventtrue to prevent closing of Writer#writable when calling Entry#getData.
Optional filenameThe encoding of the filename of the entry.
+Optional passwordThe password used to decrypt the content of the entry.
+Optional preventtrue to prevent closing of Writer#writable when calling Entry#getData.
false
Optional rawThe password used to encrypt the content of the entry (raw).
-Optional signalThe AbortSignal instance used to cancel the decompression.
Optional transfertrue to transfer streams to web workers when decompressing data.
Optional rawThe password used to encrypt the content of the entry (raw).
+Optional signalThe AbortSignal instance used to cancel the decompression.
Optional transfertrue to transfer streams to web workers when decompressing data.
true
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
true
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
true
Generated using TypeDoc
Generated using TypeDoc
Represents the options passed to ZipReader#getEntries and ZipReader#getEntriesGenerator.
-Optional commentThe encoding of the comment of the entry.
-Optional filenameThe encoding of the filename of the entry.
-Optional onprogressThe function called each time an entry is read/written.
+Represents the options passed to ZipReader#getEntries and ZipReader#getEntriesGenerator.
+Optional commentThe encoding of the comment of the entry.
+Optional filenameThe encoding of the filename of the entry.
+Optional onprogressThe function called each time an entry is read/written.
The entry index.
The total number of entries.
The entry being read/written.
An empty promise or undefined.
Generated using TypeDoc
Generated using TypeDoc
Represents options passed to the constructor of ZipReader and Entry#getData.
-Optional checktrue to check the signature of the entry.
Represents options passed to the constructor of ZipReader and Entry#getData.
+Optional checktrue to check the signature of the entry.
false
Optional passwordThe password used to decrypt the content of the entry.
-Optional preventtrue to prevent closing of Writer#writable when calling Entry#getData.
Optional passwordThe password used to decrypt the content of the entry.
+Optional preventtrue to prevent closing of Writer#writable when calling Entry#getData.
false
Optional rawThe password used to encrypt the content of the entry (raw).
-Optional signalThe AbortSignal instance used to cancel the decompression.
Optional transfertrue to transfer streams to web workers when decompressing data.
Optional rawThe password used to encrypt the content of the entry (raw).
+Optional signalThe AbortSignal instance used to cancel the decompression.
Optional transfertrue to transfer streams to web workers when decompressing data.
true
Generated using TypeDoc
Generated using TypeDoc
Represents the options passed to ZipWriter#add.
-Optional bufferedtrue to write entry data in a buffer before appending it to the zip file.
Represents the options passed to ZipWriter#add.
+Optional bufferedtrue to write entry data in a buffer before appending it to the zip file.
bufferedWrite is automatically set to true when compressing more than one entry in parallel.
false
Optional commentThe comment of the entry.
-Optional creationThe creation date.
+Optional commentThe comment of the entry.
+Optional creationThe creation date.
This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.
The current date.
Optional datatrue to to add a data descriptor.
Optional datatrue to to add a data descriptor.
When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.
true
Optional datatrue to add the signature of the data descriptor.
Optional datatrue to add the signature of the data descriptor.
false
Optional directorytrue if the entry is a directory.
Optional directorytrue if the entry is a directory.
false
Optional encryptionThe encryption strength (AES).
+Optional encryptionThe encryption strength (AES).
3
Optional extendedtrue to store extended timestamp extra fields.
Optional extendedtrue 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.
true
Optional externalThe external file attribute.
+Optional externalThe external file attribute.
0
Optional extraThe extra field of the entry.
-Optional internalThe internal file attribute.
+Optional extraThe extra field of the entry.
+Optional internalThe internal file attribute.
0
Optional keeptrue to keep the order of the entry physically in the zip file.
Optional keeptrue 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.
Another solution to improve the use of web workers is to add entries from smallest to largest in uncompressed size.
true
Optional lastThe last access date.
+Optional lastThe last access date.
This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.
The current date.
Optional lastThe last modification date.
+Optional lastThe last modification date.
The current date.
Optional levelThe level of compression.
+Optional levelThe level of compression.
The minimum value is 0 and means that no compression is applied. The maximum value is 9.
5
Optional mstrue to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.
Optional mstrue to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.
true
Optional passwordThe password used to encrypt the content of the entry.
-Optional preventtrue to prevent closing of WritableWriter#writable.
Optional passwordThe password used to encrypt the content of the entry.
+Optional preventtrue to prevent closing of WritableWriter#writable.
false
Optional rawThe password used to encrypt the content of the entry (raw).
-Optional signalThe AbortSignal instance used to cancel the compression.
Optional supportfalse to never write disk numbers in zip64 data.
Optional rawThe password used to encrypt the content of the entry (raw).
+Optional signalThe AbortSignal instance used to cancel the compression.
Optional supportfalse to never write disk numbers in zip64 data.
true
Optional usdztrueto produce zip files compatible with the USDZ specification.
Optional usdztrueto produce zip files compatible with the USDZ specification.
false
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
Optional usetrue to use the native API CompressionStream/DecompressionStream to compress/decompress data.
true
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
Optional usetrue to use web workers to compress/decompress data in non-blocking background processes.
true
Optional versionThe "Version" field.
-Optional versionThe "Version made by" field.
+Optional versionThe "Version" field.
+Optional versionThe "Version made by" field.
20
Optional zip64true to use Zip64 to store the entry.
Optional zip64true 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).
false
Optional ziptrue to use the ZipCrypto algorithm to encrypt the content of the entry.
Optional ziptrue 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.
false
Optional onendOptional onendOptional onprogressGenerated using TypeDoc
Generated using TypeDoc
Represents the options passed to ZipWriter#close.
-Optional preventtrue to prevent closing of WritableWriter#writable.
Represents the options passed to ZipWriter#close.
+Optional preventtrue to prevent closing of WritableWriter#writable.
false
Optional zip64true to use Zip64 to write the entries directory.
Optional zip64true to use Zip64 to write the entries directory.
false
Optional onprogressOptional onprogressThe function called each time an entry is read/written.
The entry index.
The total number of entries.
The entry being read/written.
An empty promise or undefined.
Generated using TypeDoc
Generated using TypeDoc
Represents options passed to the constructor of ZipWriter, ZipWriter#add and {@link ZipDirectoryEntry}#export*.
Optional bufferedtrue to write entry data in a buffer before appending it to the zip file.
Represents options passed to the constructor of ZipWriter, ZipWriter#add and {@link ZipDirectoryEntry}#export*.
Optional bufferedtrue to write entry data in a buffer before appending it to the zip file.
bufferedWrite is automatically set to true when compressing more than one entry in parallel.
false
Optional creationThe creation date.
+Optional creationThe creation date.
This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.
The current date.
Optional datatrue to to add a data descriptor.
Optional datatrue to to add a data descriptor.
When set to false, the ZipWriterConstructorOptions#bufferedWrite option will automatically be set to true.
true
Optional datatrue to add the signature of the data descriptor.
Optional datatrue to add the signature of the data descriptor.
false
Optional encryptionThe encryption strength (AES).
+Optional encryptionThe encryption strength (AES).
3
Optional extendedtrue to store extended timestamp extra fields.
Optional extendedtrue 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.
true
Optional externalThe external file attribute.
+Optional externalThe external file attribute.
0
Optional internalThe internal file attribute.
+Optional internalThe internal file attribute.
0
Optional keeptrue to keep the order of the entry physically in the zip file.
Optional keeptrue 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.
Another solution to improve the use of web workers is to add entries from smallest to largest in uncompressed size.
true
Optional lastThe last access date.
+Optional lastThe last access date.
This option is ignored if the ZipWriterConstructorOptions#extendedTimestamp option is set to false.
The current date.
Optional lastThe last modification date.
+Optional lastThe last modification date.
The current date.
Optional levelThe level of compression.
+Optional levelThe level of compression.
The minimum value is 0 and means that no compression is applied. The maximum value is 9.
5
Optional mstrue to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.
Optional mstrue to write EntryMetaData#externalFileAttribute in MS-DOS format for folder entries.
true
Optional passwordThe password used to encrypt the content of the entry.
-Optional preventtrue to prevent closing of WritableWriter#writable.
Optional passwordThe password used to encrypt the content of the entry.
+Optional preventtrue to prevent closing of WritableWriter#writable.
false
Optional rawThe password used to encrypt the content of the entry (raw).
-Optional signalThe AbortSignal instance used to cancel the compression.
Optional supportfalse to never write disk numbers in zip64 data.
Optional rawThe password used to encrypt the content of the entry (raw).
+Optional signalThe AbortSignal instance used to cancel the compression.
Optional supportfalse to never write disk numbers in zip64 data.
true
Optional usdztrueto produce zip files compatible with the USDZ specification.
Optional usdztrueto produce zip files compatible with the USDZ specification.
false
Optional versionThe "Version" field.
-Optional versionThe "Version made by" field.
+Optional versionThe "Version" field.
+Optional versionThe "Version made by" field.
20
Optional zip64true to use Zip64 to store the entry.
Optional zip64true 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).
false
Optional ziptrue to use the ZipCrypto algorithm to encrypt the content of the entry.
Optional ziptrue 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.
false
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Represents the callback function used to register the data event handler.
The third-party codec instance.
+Represents the callback function used to register the data event handler.
The third-party codec instance.
The data event handler.
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Const Generated using TypeDoc
Const Zip format error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Central Directory not found error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Duplicate entry error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Encrypted entry error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Zip64 End of Central Directory Locator not found error
+Generated using TypeDoc
Const Generated using TypeDoc
Const End of Central Directory Record not found error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Zip64 End of Central Directory Record not found error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Extra field Zip64 not found error
+Generated using TypeDoc
Const Generated using TypeDoc
Const HTTP range error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Invalid comment error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Invalid encryption strength error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Invalid entry comment error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Invalid entry name error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Invalid extra field data error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Invalid extra field type error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Invalid password error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Invalid signature error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Invalid version error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Iteration completed too soon error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Local file header not found error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Split zip file error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Unsupported compression error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Unsupported encryption error
+Generated using TypeDoc
Const Generated using TypeDoc
Const Invalid format error
+Generated using TypeDoc
Const The Filesystem API.
+Const The Filesystem API.
The Filesystem constructor.
{@link FS}
The ZipFileEntry constructor.
{@link ZipFileEntry}
Generated using TypeDoc
Generated using TypeDoc
Represents a Reader instance used to read data provided as a
-Blobinstance.