fflate/docs/README.md

fflate

Index

Interfaces

• AsyncDeflateOptions
• AsyncGunzipOptions
• AsyncGzipOptions
• AsyncInflateOptions
• AsyncTerminable
• AsyncUnzlibOptions
• AsyncZipOptions
• AsyncZippable
• AsyncZlibOptions
• DeflateOptions
• GzipOptions
• Unzipped
• ZipOptions
• Zippable
• ZlibOptions

Type aliases

• AsyncZippableFile
• FlateCallback
• UnzipCallback
• ZippableFile

Functions

• decompress
• decompressSync
• deflate
• deflateSync
• gunzip
• gunzipSync
• gzip
• gzipSync
• inflate
• inflateSync
• unzip
• unzipSync
• unzlib
• unzlibSync
• zip
• zipSync
• zlib
• zlibSync

Type aliases

AsyncZippableFile

Ƭ AsyncZippableFile: Uint8Array | []

A file that can be used to asynchronously createa a ZIP archive

---

FlateCallback

Ƭ FlateCallback: (err: Error,data: Uint8Array) => unknown

Callback for asynchronous (de)compression methods

param Any error that occurred

param The resulting data. Only present if err is null

---

UnzipCallback

Ƭ UnzipCallback: (err: Error,data: Unzipped) => unknown

Callback for asynchronous ZIP decompression

param Any error that occurred

param The decompressed ZIP archive

---

ZippableFile

Ƭ ZippableFile: Uint8Array | []

A file that can be used to create a ZIP archive

Functions

decompress

▸ decompress(data: Uint8Array, opts: AsyncInflateOptions, cb: FlateCallback): AsyncTerminable

Asynchrononously expands compressed GZIP, Zlib, or raw DEFLATE data, automatically detecting the format

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
opts	AsyncInflateOptions	The decompression options
cb	FlateCallback	The function to be called upon decompression completion

Returns: AsyncTerminable

▸ decompress(data: Uint8Array, cb: FlateCallback): AsyncTerminable

Asynchrononously expands compressed GZIP, Zlib, or raw DEFLATE data, automatically detecting the format

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
cb	FlateCallback	The function to be called upon decompression completion

Returns: AsyncTerminable

---

decompressSync

▸ decompressSync(data: Uint8Array, out?: Uint8Array): Uint8Array

Expands compressed GZIP, Zlib, or raw DEFLATE data, automatically detecting the format

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
out?	Uint8Array	Where to write the data. Saves memory if you know the decompressed size and provide an output buffer of that length.

Returns: Uint8Array

---

deflate

▸ deflate(data: Uint8Array, opts: AsyncDeflateOptions, cb: FlateCallback): AsyncTerminable

Asynchronously compresses data with DEFLATE without any wrapper

Parameters:

Name	Type	Description
data	Uint8Array	The data to compress
opts	AsyncDeflateOptions	The compression options
cb	FlateCallback	The function to be called upon compression completion

Returns: AsyncTerminable

▸ deflate(data: Uint8Array, cb: FlateCallback): AsyncTerminable

Asynchronously compresses data with DEFLATE without any wrapper

Parameters:

Name	Type	Description
data	Uint8Array	The data to compress
cb	FlateCallback	The function to be called upon compression completion

Returns: AsyncTerminable

---

deflateSync

▸ deflateSync(data: Uint8Array, opts?: DeflateOptions): Uint8Array

Compresses data with DEFLATE without any wrapper

Parameters:

Name	Type	Description
data	Uint8Array	The data to compress
opts?	DeflateOptions	The compression options

Returns: Uint8Array

---

gunzip

▸ gunzip(data: Uint8Array, opts: AsyncGunzipOptions, cb: FlateCallback): AsyncTerminable

Asynchronously expands GZIP data

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
opts	AsyncGunzipOptions	The decompression options
cb	FlateCallback	The function to be called upon decompression completion

Returns: AsyncTerminable

▸ gunzip(data: Uint8Array, cb: FlateCallback): AsyncTerminable

Asynchronously expands GZIP data

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
cb	FlateCallback	The function to be called upon decompression completion

Returns: AsyncTerminable

---

gunzipSync

▸ gunzipSync(data: Uint8Array, out?: Uint8Array): Uint8Array

Expands GZIP data

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
out?	Uint8Array	Where to write the data. GZIP already encodes the output size, so providing this doesn't save memory.

Returns: Uint8Array

---

gzip

▸ gzip(data: Uint8Array, opts: AsyncGzipOptions, cb: FlateCallback): AsyncTerminable

Asynchronously compresses data with GZIP

Parameters:

Name	Type	Description
data	Uint8Array	The data to compress
opts	AsyncGzipOptions	The compression options
cb	FlateCallback	The function to be called upon compression completion

Returns: AsyncTerminable

▸ gzip(data: Uint8Array, cb: FlateCallback): AsyncTerminable

Asynchronously compresses data with GZIP

Parameters:

Name	Type	Description
data	Uint8Array	The data to compress
cb	FlateCallback	The function to be called upon compression completion

Returns: AsyncTerminable

▸ gzip(data: Uint8Array, opts: AsyncGzipOptions, cb: FlateCallback): AsyncTerminable

Asynchronously compresses data with GZIP

Parameters:

Name	Type	Description
data	Uint8Array	The data to compress
opts	AsyncGzipOptions	The compression options
cb	FlateCallback	The function to be called upon compression completion

Returns: AsyncTerminable

▸ gzip(data: Uint8Array, cb: FlateCallback): AsyncTerminable

Asynchronously compresses data with GZIP

Parameters:

Name	Type	Description
data	Uint8Array	The data to compress
cb	FlateCallback	The function to be called upon compression completion

Returns: AsyncTerminable

---

gzipSync

▸ gzipSync(data: Uint8Array, opts?: GzipOptions): Uint8Array

Compresses data with GZIP

Parameters:

Name	Type	Description
data	Uint8Array	The data to compress
opts?	GzipOptions	The compression options

Returns: Uint8Array

---

inflate

▸ inflate(data: Uint8Array, opts: AsyncInflateOptions, cb: FlateCallback): AsyncTerminable

Asynchronously expands DEFLATE data with no wrapper

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
opts	AsyncInflateOptions	The decompression options
cb	FlateCallback	The function to be called upon decompression completion

Returns: AsyncTerminable

▸ inflate(data: Uint8Array, cb: FlateCallback): AsyncTerminable

Asynchronously expands DEFLATE data with no wrapper

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
cb	FlateCallback	The function to be called upon decompression completion

Returns: AsyncTerminable

---

inflateSync

▸ inflateSync(data: Uint8Array, out?: Uint8Array): Uint8Array

Expands DEFLATE data with no wrapper

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
out?	Uint8Array	Where to write the data. Saves memory if you know the decompressed size and provide an output buffer of that length.

Returns: Uint8Array

---

unzip

▸ unzip(data: Uint8Array, cb: UnzipCallback): AsyncTerminable

Asynchronously decompresses a ZIP archive

Parameters:

Name	Type	Description
data	Uint8Array	The raw compressed ZIP file
cb	UnzipCallback	The callback to call with the decompressed files

Returns: AsyncTerminable

---

unzipSync

▸ unzipSync(data: Uint8Array): Unzipped

Synchronously decompresses a ZIP archive

Parameters:

Name	Type	Description
data	Uint8Array	The raw compressed ZIP file

Returns: Unzipped

---

unzlib

▸ unzlib(data: Uint8Array, opts: AsyncGunzipOptions, cb: FlateCallback): AsyncTerminable

Asynchronously expands Zlib data

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
opts	AsyncGunzipOptions	The decompression options
cb	FlateCallback	The function to be called upon decompression completion

Returns: AsyncTerminable

▸ unzlib(data: Uint8Array, cb: FlateCallback): AsyncTerminable

Asynchronously expands Zlib data

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
cb	FlateCallback	The function to be called upon decompression completion

Returns: AsyncTerminable

---

unzlibSync

▸ unzlibSync(data: Uint8Array, out?: Uint8Array): Uint8Array

Expands Zlib data

Parameters:

Name	Type	Description
data	Uint8Array	The data to decompress
out?	Uint8Array	Where to write the data. Saves memory if you know the decompressed size and provide an output buffer of that length.

Returns: Uint8Array

---

zip

▸ zip(data: AsyncZippable, opts: AsyncZipOptions, cb: FlateCallback): AsyncTerminable

Asynchronously creates a ZIP file

Parameters:

Name	Type	Description
data	AsyncZippable	The directory structure for the ZIP archive
opts	AsyncZipOptions	The main options, merged with per-file options
cb	FlateCallback	The callback to call with the generated ZIP archive

Returns: AsyncTerminable

▸ zip(data: AsyncZippable, cb: FlateCallback): AsyncTerminable

Asynchronously creates a ZIP file

Parameters:

Name	Type	Description
data	AsyncZippable	The directory structure for the ZIP archive
cb	FlateCallback	The callback to call with the generated ZIP archive

Returns: AsyncTerminable

---

zipSync

▸ zipSync(data: Zippable, opts: ZipOptions): Uint8Array

Synchronously creates a ZIP file. Prefer using zip for better performance with more than one file.

Parameters:

Name	Type	Default value	Description
data	Zippable	-	The directory structure for the ZIP archive
opts	ZipOptions	{}	The main options, merged with per-file options

Returns: Uint8Array

---

zlib

▸ zlib(data: Uint8Array, opts: AsyncZlibOptions, cb: FlateCallback): AsyncTerminable

Asynchronously compresses data with Zlib

Parameters:

Name	Type	Description
data	Uint8Array	The data to compress
opts	AsyncZlibOptions	The compression options
cb	FlateCallback	The function to be called upon compression completion

Returns: AsyncTerminable

▸ zlib(data: Uint8Array, cb: FlateCallback): AsyncTerminable

Asynchronously compresses data with Zlib

Parameters:

Name	Type	Description
data	Uint8Array	The data to compress
cb	FlateCallback	The function to be called upon compression completion

Returns: AsyncTerminable

---

zlibSync

▸ zlibSync(data: Uint8Array, opts?: ZlibOptions): Uint8Array

Compress data with Zlib

Parameters:

Name	Type	Description
data	Uint8Array	The data to compress
opts?	ZlibOptions	The compression options

Returns: Uint8Array