ReadonlychildrenThe array of all the ZipEntry instances indexed by ZipEntry#id.
The root directory.
Adds a entry entry with content provided as a Blob instance
The relative filename of the entry.
The Blob instance.
Optionaloptions: ZipWriterAddDataOptions
The options.
A ZipFileEntry instance.
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.
Optionaloptions: ZipWriterAddDataOptions
The options.
A ZipFileEntry instance.
Adds a directory
The relative filename of the directory.
Optionaloptions: ZipWriterAddDataOptions
The options.
A ZipDirectoryEntry instance.
Adds an entry with content provided via a File instance
The File instance.
Optionaloptions: ZipWriterAddDataOptions
The options.
A promise resolving to a ZipFileEntry or a ZipDirectoryEntry instance.
Adds an entry with content provided via a FileSystemEntry instance
The FileSystemEntry instance.
Optionaloptions: ZipWriterAddDataOptions
The options.
A promise resolving to an array of ZipFileEntry or a ZipDirectoryEntry instances.
Adds an entry with content provided via a FileSystemHandle instance
If a handle cannot be read, the original error is rethrown unmodified as an EntryError,
whose EntryError#entryName is the path of the handle that failed, relative to the parent
of fileSystemHandle.
The fileSystemHandle instance.
Optionaloptions: ZipWriterAddDataOptions
The options.
A promise resolving to an array of ZipFileEntry or a ZipDirectoryEntry instances.
Adds an entry with content fetched from a URL
The relative filename of the entry.
The URL.
Optionaloptions: HttpOptions & ZipWriterAddDataOptions
The options.
A ZipFileEntry instance.
Adds a entry entry with content provided via a ReadableStream instance
The relative filename of the entry.
The ReadableStream instance.
Optionaloptions: ZipWriterAddDataOptions
The options.
A ZipFileEntry instance.
Adds an entry with content provided as text
The relative filename of the entry.
The text.
Optionaloptions: ZipWriterAddDataOptions
The options.
A ZipFileEntry instance.
Adds an entry with content provided as a Uint8Array instance
The relative filename of the entry.
The Uint8Array instance.
Optionaloptions: ZipWriterAddDataOptions
The options.
A ZipFileEntry instance.
Tests the password on the entry and all children if any, returns true if the entry is not password protected
Optionaloptions: EntryGetDataOptionsReturns a Blob instance containing a zip file of the entry and its descendants
Optionaloptions: ZipDirectoryEntryExportOptions
The 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
Optionaloptions: ZipDirectoryEntryExportOptions
The options.
A promise resolving to the Data URI string encoded in Base64.
Writes the entry and its descendants into a directory as files and sub-directories via the File System Access API (e.g. the Origin Private File System). Files are streamed and directories are merged into the target; colliding files are overwritten. This is the inverse of ZipDirectoryEntry#addFileSystemHandle.
If an entry cannot be written, the original error is rethrown unmodified as an EntryError, whose EntryError#entryName is the name of the entry that failed, relative to this entry.
The export is not atomic and nothing is rolled back, because the target is merged into rather than replaced: a file that already existed cannot be restored once overwritten. On failure the target is left as follows, and EntryError#exportedEntryNames lists the files that completed:
concurrent, every entry
cancelled alongside it;Running the same export again is the supported way to recover, since directories are merged and files are overwritten.
The target FileSystemDirectoryHandle instance.
Optionaloptions: ZipDirectoryEntryExportFileSystemHandleOptions
The options.
A promise resolving to the target FileSystemDirectoryHandle instance.
Returns a Uint8Array instance containing a zip file of the entry and its descendants
Optionaloptions: ZipDirectoryEntryExportOptions
The options.
A promise resolving to the Uint8Array instance.
Creates a zip file via a WritableStream instance containing the entry and its descendants
Optionalwritable: WritableStream<any>
The WritableStream instance.
Optionaloptions: ZipDirectoryEntryExportOptions
The options.
A promise resolving to the Uint8Array instance.
Creates a zip file via a custom Writer instance containing the entry and its descendants
The Writer instance.
Optionaloptions: ZipDirectoryEntryExportOptions
The options.
A promise resolving to the data.
Returns a ZipEntry instance from the value of ZipEntry#id
The id of the ZipEntry instance.
The ZipEntry instance.
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).
Extracts a zip file provided as a Blob instance into the entry
The Blob instance.
Optionaloptions: ZipReaderConstructorOptions
The options.
Extracts a zip file provided as a Data URI string encoded in Base64 into the entry
The Data URI string encoded in Base64.
Optionaloptions: ZipReaderConstructorOptions
The options.
Extracts a zip file fetched from a URL into the entry
The URL.
Optionaloptions: ZipDirectoryEntryImportHttpOptions
The options.
Extracts a zip file provided via a ReadableStream instance into the entry
The ReadableStream instance.
Optionaloptions: ZipReaderConstructorOptions
The options.
Extracts a zip file provided as a Uint8Array instance into the entry
The Uint8Array instance.
Optionaloptions: ZipReaderConstructorOptions
The options.
Extracts a zip file provided via a custom Reader instance into the entry
The Reader instance.
Optionaloptions: ZipReaderConstructorOptions
The options.
The filename of each entry is split into path components to build the tree of entries. Empty
components and "." components are ignored, so "a//b.txt", "./a/b.txt" and "a/./b.txt" all produce
the same "a/b.txt" entry. Filenames are normalized and validated beforehand, see
GetEntriesOptions#normalizeFilename and GetEntriesOptions#filenameValidation.
Tests if the entry or any of its children is password protected
Moves a ZipEntry instance and its children into a ZipDirectoryEntry instance
The ZipEntry instance to move.
The ZipDirectoryEntry instance.
The children of the root directory.