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 Summary)

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: string,
    blob: Blob,
    options?: ZipWriterAddDataOptions,
): 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.
- Optionaloptions: ZipWriterAddDataOptions
  The options.
Returns ZipFileEntry<Blob, Blob>
A ZipFileEntry instance.
Inherited from ZipDirectoryEntry.addBlob
- Defined in index.d.ts:1919

addData64URI

addData64URI(
    name: string,
    dataURI: string,
    options?: ZipWriterAddDataOptions,
): 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.
- Optionaloptions: ZipWriterAddDataOptions
  The options.
Returns ZipFileEntry<string, string>
A ZipFileEntry instance.
Inherited from ZipDirectoryEntry.addData64URI
- Defined in index.d.ts:1932

addDirectory

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

addFile

addFile(file: File, options?: ZipWriterAddDataOptions): Promise<ZipEntry>
Adds an entry with content provided via a File instance
Parameters
- file: File
  The File instance.
- Optionaloptions: 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:1983

addFileSystemEntry

addFileSystemEntry(
fileSystemEntry: FileSystemEntryLike,
options?: ZipWriterAddDataOptions,
): Promise<ZipEntry[]>
Adds an entry with content provided via a FileSystemEntry instance
Parameters
- fileSystemEntry: FileSystemEntryLike
  The FileSystemEntry instance.
- Optionaloptions: 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:1991

addFileSystemHandle

addFileSystemHandle(
fileSystemHandle: FileSystemHandleLike,
options?: ZipWriterAddDataOptions,
): Promise<ZipEntry[]>
Adds an entry with content provided via a FileSystemHandle instance
Parameters
- fileSystemHandle: FileSystemHandleLike
  The fileSystemHandle instance.
- Optionaloptions: 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:2002

addHttpContent

addHttpContent(
    name: string,
    url: string,
    options?: HttpOptions & ZipWriterAddDataOptions,
): 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.
- Optionaloptions: HttpOptions & ZipWriterAddDataOptions
  The options.
Returns ZipFileEntry<string, void>
A ZipFileEntry instance.
Inherited from ZipDirectoryEntry.addHttpContent
- Defined in index.d.ts:1958

addReadable

addReadable(
    name: string,
    readable: ReadableStream,
    options?: ZipWriterAddDataOptions,
): 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
  The ReadableStream instance.
- Optionaloptions: ZipWriterAddDataOptions
  The options.
Returns ZipFileEntry<ReadableStream<any>, void>
A ZipFileEntry instance.
Inherited from ZipDirectoryEntry.addReadable
- Defined in index.d.ts:1971

addText

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

addUint8Array

addUint8Array(
    name: string,
    array: Uint8Array,
    options?: ZipWriterAddDataOptions,
): ZipFileEntry<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>
Adds an entry with content provided as a Uint8Array instance
Parameters
- name: string
  The relative filename of the entry.
- array: Uint8Array
  The Uint8Array instance.
- Optionaloptions: ZipWriterAddDataOptions
  The options.
Returns ZipFileEntry<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>
A ZipFileEntry instance.
Inherited from ZipDirectoryEntry.addUint8Array
- Defined in index.d.ts:1945

checkPassword

checkPassword(password: string, options?: EntryGetDataOptions): 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
- Optionaloptions: EntryGetDataOptions
Returns Promise<boolean>
Inherited from ZipDirectoryEntry.checkPassword
- Defined in index.d.ts:1735

clone

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

exportBlob

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

exportData64URI

exportData64URI(options?: ZipDirectoryEntryExportOptions): Promise<string>
Returns a Data URI string encoded in Base64 containing a zip file of the entry and its descendants
Parameters
- Optionaloptions: 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:2085

exportUint8Array

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

exportWritable

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

exportZip

exportZip(
    writer:
        | WritableStream<any>
        | WritableWriter
        | Writer<unknown>
        | AsyncGenerator<
            WritableStream<any>
            | WritableWriter
            | Writer<unknown>,
            any,
            any,
        >,
    options?: ZipDirectoryEntryExportOptions,
): 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,
          any,
      >
  The Writer instance.
- Optionaloptions: ZipDirectoryEntryExportOptions
  The options.
Returns Promise<unknown>
A promise resolving to the data.
Inherited from ZipDirectoryEntry.exportZip
- Defined in index.d.ts:2113

find

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

getById

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

getChildByName

getChildByName(name: string): ZipEntry | undefined
Gets a ZipEntry child instance from its relative filename
Parameters
- name: string
  The relative filename.
Returns ZipEntry | undefined
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:1886

getFullname

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

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

getRelativeName

getRelativeName(ancestor: ZipDirectoryEntry): 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:1721

importBlob

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

importData64URI

importData64URI(
dataURI: string,
options?: ZipReaderConstructorOptions,
): 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.
- Optionaloptions: ZipReaderConstructorOptions
  The options.
Returns Promise<[ZipEntry]>
Inherited from ZipDirectoryEntry.importData64URI
- Defined in index.d.ts:2022

importHttpContent

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

importReadable

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

importUint8Array

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

importZip

importZip(
    reader:
        | ReadableStream<any>
        | ReadableReader
        | Reader<unknown>
        | Reader<unknown>[]
        | ReadableReader[]
        | ReadableStream<any>[],
    options?: ZipReaderConstructorOptions,
): 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.
- Optionaloptions: ZipReaderConstructorOptions
  The options.
Returns Promise<[ZipEntry]>
Inherited from ZipDirectoryEntry.importZip
- Defined in index.d.ts:2062

isDescendantOf

isDescendantOf(ancestor: ZipDirectoryEntry): 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:1727

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:1731

move

move(entry: ZipEntry, destination: ZipDirectoryEntry): 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:2185

remove

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

rename

rename(name: string): 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:1744

Class FS

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FS

Properties

children

Optionaldata

directory

id

name

Optionalparent

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<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>

checkPassword

Parameters

Returns Promise<boolean>

clone

Parameters

Returns ZipEntry

exportBlob

Parameters

Returns Promise<Blob>

exportData64URI

Parameters

Returns Promise<string>

exportUint8Array

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

exportWritable

Parameters

Returns Promise<WritableStream<any>>

exportZip

Parameters

Returns Promise<unknown>

find

Parameters

Returns ZipEntry | undefined

getById

Parameters

Returns ZipEntry | undefined

getChildByName

Parameters

Returns ZipEntry | undefined

`Optional`data

`Optional`parent