Class FS

Represents a Filesystem instance.

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)

ZipDirectoryEntry
- FS

Constructors

constructor

new FS(): FS
Returns FS
Inherited from ZipDirectoryEntry.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.

root

root: ZipDirectoryEntry

The root directory.

uncompressedSize

uncompressedSize: number

The uncompressed size of the content.

Methods

addBlob

addBlob(name, blob, options?): ZipFileEntry<Blob, Blob>
Adds a entry entry with content provided as a Blob instance
Parameters
- name: string
  The relative filename of the entry.
- blob: Blob
  The Blob instance.
- Optional options: ZipWriterAddDataOptions
  The options.
Returns ZipFileEntry<Blob, Blob>
A ZipFileEntry instance.
Inherited from ZipDirectoryEntry.addBlob
- Defined in index.d.ts:1627

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.
Inherited from ZipDirectoryEntry.addData64URI
- Defined in index.d.ts:1640

addDirectory

addDirectory(name, options?): ZipDirectoryEntry
Adds a directory
Parameters
- name: string
  The relative filename of the directory.
- Optional options: ZipWriterAddDataOptions
  The options.
Returns ZipDirectoryEntry
A ZipDirectoryEntry instance.
Inherited from ZipDirectoryEntry.addDirectory
- Defined in index.d.ts:1602

addFile

addFile(file, options?): Promise<ZipEntry>
Adds an entry with content provided via a File instance
Parameters
- file: File
  The File instance.
- Optional options: ZipWriterAddDataOptions
  The options.
Returns Promise<ZipEntry>
A promise resolving to a ZipFileEntry or a ZipDirectoryEntry instance.
Inherited from ZipDirectoryEntry.addFile
- Defined in index.d.ts:1691

addFileSystemEntry

addFileSystemEntry(fileSystemEntry, options?): Promise<ZipEntry[]>
Adds an entry with content provided via a FileSystemEntry instance
Parameters
- fileSystemEntry: FileSystemEntryLike
  The FileSystemEntry instance.
- Optional options: ZipWriterAddDataOptions
  The options.
Returns Promise<ZipEntry[]>
A promise resolving to an array of ZipFileEntry or a ZipDirectoryEntry instances.
Inherited from ZipDirectoryEntry.addFileSystemEntry
- Defined in index.d.ts:1702

addFileSystemHandle

addFileSystemHandle(fileSystemHandle, options?): Promise<ZipEntry[]>
Adds an entry with content provided via a FileSystemHandle instance
Parameters
- fileSystemHandle: FileSystemHandleLike
  The fileSystemHandle instance.
- Optional options: ZipWriterAddDataOptions
  The options.
Returns Promise<ZipEntry[]>
A promise resolving to an array of ZipFileEntry or a ZipDirectoryEntry instances.
Inherited from ZipDirectoryEntry.addFileSystemHandle
- Defined in index.d.ts:1713

addHttpContent

addHttpContent(name, url, options?): ZipFileEntry<string, void>
Adds an entry with content fetched from a URL
Parameters
- name: string
  The relative filename of the entry.
- url: string
  The URL.
- Optional options: HttpOptions & ZipWriterAddDataOptions
  The options.
Returns ZipFileEntry<string, void>
A ZipFileEntry instance.
Inherited from ZipDirectoryEntry.addHttpContent
- Defined in index.d.ts:1666

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.
Inherited from ZipDirectoryEntry.addReadable
- Defined in index.d.ts:1679

addText

addText(name, text, options?): ZipFileEntry<string, string>
Adds an entry with content provided as text
Parameters
- name: string
  The relative filename of the entry.
- text: string
  The text.
- Optional options: ZipWriterAddDataOptions
  The options.
Returns ZipFileEntry<string, string>
A ZipFileEntry instance.
Inherited from ZipDirectoryEntry.addText
- Defined in index.d.ts:1614

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.
Inherited from ZipDirectoryEntry.addUint8Array
- Defined in index.d.ts:1653

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
- password: string
- Optional options: EntryGetDataOptions
Returns Promise<boolean>
Inherited from ZipDirectoryEntry.checkPassword
- Defined in index.d.ts:1450

clone

clone(deepClone?): ZipEntry
Clones the entry
Parameters
- Optional deepClone: boolean
  true to clone all the descendants.
Returns ZipEntry
Inherited from ZipDirectoryEntry.clone
- Defined in index.d.ts:1428

exportBlob

exportBlob(options?): Promise<Blob>
Returns a Blob instance containing a zip file of the entry and its descendants
Parameters
- Optional options: ZipDirectoryEntryExportOptions
  The options.
Returns Promise<Blob>
A promise resolving to the Blob instance.
Inherited from ZipDirectoryEntry.exportBlob
- Defined in index.d.ts:1789

exportData64URI

exportData64URI(options?): Promise<string>
Returns a Data URI string encoded in Base64 containing a zip file of the entry and its descendants
Parameters
- Optional options: ZipDirectoryEntryExportOptions
  The options.
Returns Promise<string>
A promise resolving to the Data URI string encoded in Base64.
Inherited from ZipDirectoryEntry.exportData64URI
- Defined in index.d.ts:1796

exportUint8Array

exportUint8Array(options?): Promise<Uint8Array>
Returns a Uint8Array instance containing a zip file of the entry and its descendants
Parameters
- Optional options: ZipDirectoryEntryExportOptions
  The options.
Returns Promise<Uint8Array>
A promise resolving to the Uint8Array instance.
Inherited from ZipDirectoryEntry.exportUint8Array
- Defined in index.d.ts:1803

exportWritable

exportWritable(writable?, options?): Promise<WritableStream<any>>
Creates a zip file via a WritableStream instance containing the entry and its descendants
Parameters
- Optional writable: WritableStream<any>
  The WritableStream instance.
- Optional options: ZipDirectoryEntryExportOptions
  The options.
Returns Promise<WritableStream<any>>
A promise resolving to the Uint8Array instance.
Inherited from ZipDirectoryEntry.exportWritable
- Defined in index.d.ts:1813

exportZip

exportZip(writer, options?): Promise<unknown>
Creates a zip file via a custom Writer instance containing the entry and its descendants
Parameters
- writer: WritableStream<any> | WritableWriter | Writer<unknown> | AsyncGenerator<WritableStream<any> | WritableWriter | Writer<unknown>, any, unknown>
  The Writer instance.
- Optional options: ZipDirectoryEntryExportOptions
  The options.
Returns Promise<unknown>
A promise resolving to the data.
Inherited from ZipDirectoryEntry.exportZip
- Defined in index.d.ts:1824

find

find(fullname): ZipEntry
Returns a ZipEntry instance from its full filename
Parameters
- fullname: string
  The full filename.
Returns ZipEntry
The ZipEntry instance.
- Defined in index.d.ts:1901

getById

getById(id): ZipEntry
Returns a ZipEntry instance from the value of ZipEntry#id
Parameters
- id: number
  The id of the ZipEntry instance.
Returns ZipEntry
The ZipEntry instance.
- Defined in index.d.ts:1908

getChildByName

getChildByName(name): ZipEntry
Gets a ZipEntry child instance from its relative filename
Parameters
- name: string
  The relative filename.
Returns ZipEntry
A ZipFileEntry or a ZipDirectoryEntry instance (use the ZipFileEntry#directory and ZipDirectoryEntry#directory properties to differentiate entries).
Inherited from ZipDirectoryEntry.getChildByName
- Defined in index.d.ts:1594

getFullname

getFullname(): string
Returns the full filename of the entry

Returns string
Inherited from ZipDirectoryEntry.getFullname
- Defined in index.d.ts:1432

getRelativeName

getRelativeName(ancestor): string
Returns the filename of the entry relative to a parent directory
Parameters
- ancestor: ZipDirectoryEntry
Returns string
Inherited from ZipDirectoryEntry.getRelativeName
- Defined in index.d.ts:1436

importBlob

importBlob(blob, options?): Promise<[ZipEntry]>
Extracts a zip file provided as a Blob instance into the entry
Parameters
- blob: Blob
  The Blob instance.
- Optional options: ZipReaderConstructorOptions
  The options.
Returns Promise<[ZipEntry]>
Inherited from ZipDirectoryEntry.importBlob
- Defined in index.d.ts:1723

importData64URI

importData64URI(dataURI, options?): Promise<[ZipEntry]>
Extracts a zip file provided as a Data URI string encoded in Base64 into the entry
Parameters
- dataURI: string
  The Data URI string encoded in Base64.
- Optional options: ZipReaderConstructorOptions
  The options.
Returns Promise<[ZipEntry]>
Inherited from ZipDirectoryEntry.importData64URI
- Defined in index.d.ts:1733

importHttpContent

importHttpContent(url, options?): Promise<[ZipEntry]>
Extracts a zip file fetched from a URL into the entry
Parameters
- url: string
  The URL.
- Optional options: ZipDirectoryEntryImportHttpOptions
  The options.
Returns Promise<[ZipEntry]>
Inherited from ZipDirectoryEntry.importHttpContent
- Defined in index.d.ts:1753

importReadable

importReadable(readable, options?): Promise<[ZipEntry]>
Extracts a zip file provided via a ReadableStream instance into the entry
Parameters
- readable: ReadableStream<any>
  The ReadableStream instance.
- Optional options: ZipReaderConstructorOptions
  The options.
Returns Promise<[ZipEntry]>
Inherited from ZipDirectoryEntry.importReadable
- Defined in index.d.ts:1763

importUint8Array

importUint8Array(array, options?): Promise<[ZipEntry]>
Extracts a zip file provided as a Uint8Array instance into the entry
Parameters
- array: Uint8Array
  The Uint8Array instance.
- Optional options: ZipReaderConstructorOptions
  The options.
Returns Promise<[ZipEntry]>
Inherited from ZipDirectoryEntry.importUint8Array
- Defined in index.d.ts:1743

importZip

importZip(reader, options?): Promise<[ZipEntry]>
Extracts a zip file provided via a custom Reader instance into the entry
Parameters
- reader: ReadableStream<any> | ReadableReader | Reader<unknown> | Reader<unknown>[] | ReadableReader[] | ReadableStream<any>[]
  The Reader instance.
- Optional options: ZipReaderConstructorOptions
  The options.
Returns Promise<[ZipEntry]>
Inherited from ZipDirectoryEntry.importZip
- Defined in index.d.ts:1773

isDescendantOf

isDescendantOf(ancestor): boolean
Tests if a ZipDirectoryEntry instance is an ancestor of the entry
Parameters
- ancestor: ZipDirectoryEntry
  The ZipDirectoryEntry instance.
Returns boolean
Inherited from ZipDirectoryEntry.isDescendantOf
- Defined in index.d.ts:1442

isPasswordProtected

isPasswordProtected(): boolean
Tests if the entry or any of its children is password protected

Returns boolean
Inherited from ZipDirectoryEntry.isPasswordProtected
- Defined in index.d.ts:1446

move

move(entry, destination): void
Moves a ZipEntry instance and its children into a ZipDirectoryEntry instance
Parameters
- entry: ZipEntry
  The ZipEntry instance to move.
- destination: ZipDirectoryEntry
  The ZipDirectoryEntry instance.
Returns void
- Defined in index.d.ts:1894

remove

remove(entry): void
Removes a ZipEntry instance and its children
Parameters
- entry: ZipEntry
  The ZipEntry instance to remove.
Returns void
- Defined in index.d.ts:1887

rename

rename(name): void
Set the name of the entry
Parameters
- name: string
  The new name of the entry.
Returns void
Inherited from ZipDirectoryEntry.rename
- Defined in index.d.ts:1459

Class FS

Example

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FS

Properties

children

Optional data

directory

id

name

Optional parent

root

uncompressedSize

Methods

addBlob

Parameters

Returns ZipFileEntry<Blob, Blob>

addData64URI

Parameters

Returns ZipFileEntry<string, string>

addDirectory

Parameters

Returns ZipDirectoryEntry

addFile

Parameters

Returns Promise<ZipEntry>

addFileSystemEntry

Parameters

Returns Promise<ZipEntry[]>

addFileSystemHandle

Parameters

Returns Promise<ZipEntry[]>

addHttpContent

Parameters

Returns ZipFileEntry<string, void>

addReadable

Parameters

Returns ZipFileEntry<ReadableStream<any>, void>

addText

Parameters

Returns ZipFileEntry<string, string>

addUint8Array

Parameters

Returns ZipFileEntry<Uint8Array, Uint8Array>

checkPassword

Parameters

Returns Promise<boolean>

clone

Parameters

Returns ZipEntry

exportBlob

Parameters

Returns Promise<Blob>

exportData64URI

Parameters

Returns Promise<string>

exportUint8Array

Parameters

Returns Promise<Uint8Array>

exportWritable

Parameters

Returns Promise<WritableStream<any>>

exportZip

Parameters

Returns Promise<unknown>

find

Parameters

Returns ZipEntry

getById

Parameters

Returns ZipEntry

getChildByName

Parameters

Returns ZipEntry

`Optional` data

`Optional` parent