Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
classes
classes
 
 
interfaces
interfaces
 
 
README.md
README.md
 
 

README.md

fflate

Table of contents

References

Classes

Interfaces

Type Aliases

Variables

Functions

References

AsyncCompress

Renames and re-exports AsyncGzip

Compress

Renames and re-exports Gzip

compress

Renames and re-exports gzip

compressSync

Renames and re-exports gzipSync

Type Aliases

AsyncFlateDrainHandler

Ƭ AsyncFlateDrainHandler: (size: number) => void

Type declaration

▸ (size): void

Handler for the asynchronous completion of (de)compression for a data chunk

Parameters
Name Type Description
size number The number of bytes that were processed. This is measured in terms of the input (i.e. compressed bytes for decompression, uncompressed bytes for compression.)
Returns

void

AsyncFlateStreamHandler

Ƭ AsyncFlateStreamHandler: (err: FlateError | null, data: Uint8Array, final: boolean) => void

Type declaration

▸ (err, data, final): void

Handler for asynchronous data (de)compression streams

Parameters
Name Type Description
err FlateError | null Any error that occurred
data Uint8Array The data output from the stream processor
final boolean Whether this is the final block
Returns

void

AsyncZippableFile

Ƭ AsyncZippableFile: Uint8Array | AsyncZippable | [Uint8Array | AsyncZippable, AsyncZipOptions]

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

FlateCallback

Ƭ FlateCallback: (err: FlateError | null, data: Uint8Array) => void

Type declaration

▸ (err, data): void

Callback for asynchronous (de)compression methods

Parameters
Name Type Description
err FlateError | null Any error that occurred
data Uint8Array The resulting data. Only present if err is null
Returns

void

FlateStreamHandler

Ƭ FlateStreamHandler: (data: Uint8Array, final: boolean) => void

Type declaration

▸ (data, final): void

Handler for data (de)compression streams

Parameters
Name Type Description
data Uint8Array The data output from the stream processor
final boolean Whether this is the final block
Returns

void

GunzipMemberHandler

Ƭ GunzipMemberHandler: (offset: number) => void

Type declaration

▸ (offset): void

Handler for new GZIP members in concatenated GZIP streams. Useful for building indices used to perform random-access reads on compressed files.

Parameters
Name Type Description
offset number The offset of the new member relative to the start of the stream
Returns

void

StringStreamHandler

Ƭ StringStreamHandler: (data: string, final: boolean) => void

Type declaration

▸ (data, final): void

Handler for string generation streams

Parameters
Name Type Description
data string The string output from the stream processor
final boolean Whether this is the final block
Returns

void

UnzipCallback

Ƭ UnzipCallback: (err: FlateError | null, data: Unzipped) => void

Type declaration

▸ (err, data): void

Callback for asynchronous ZIP decompression

Parameters
Name Type Description
err FlateError | null Any error that occurred
data Unzipped The decompressed ZIP archive
Returns

void

UnzipFileFilter

Ƭ UnzipFileFilter: (file: UnzipFileInfo) => boolean

Type declaration

▸ (file): boolean

A filter for files to be extracted during the unzipping process

Parameters
Name Type Description
file UnzipFileInfo The info for the current file being processed
Returns

boolean

Whether or not to extract the current file

UnzipFileHandler

Ƭ UnzipFileHandler: (file: UnzipFile) => void

Type declaration

▸ (file): void

Handler for streaming ZIP decompression

Parameters
Name Type Description
file UnzipFile The file that was found in the archive
Returns

void

ZippableFile

Ƭ ZippableFile: Uint8Array | Zippable | [Uint8Array | Zippable, ZipOptions]

A file that can be used to create a ZIP archive

Variables

FlateErrorCode

• Const FlateErrorCode: Object

Codes for errors generated within this library

Type declaration

Name Type
ExtraFieldTooLong 9
FilenameTooLong 11
InvalidBlockType 1
InvalidDate 10
InvalidDistance 3
InvalidHeader 6
InvalidLengthLiteral 2
InvalidUTF8 8
InvalidZipData 13
NoCallback 7
NoStreamHandler 5
StreamFinished 4
StreamFinishing 12
UnexpectedEOF 0
UnknownCompressionMethod 14

Functions

decompress

▸ decompress(data, opts, cb): 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

A function that can be used to immediately terminate the decompression

▸ decompress(data, cb): 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

A function that can be used to immediately terminate the decompression

decompressSync

▸ decompressSync(data, opts?): Uint8Array

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

Parameters

Name Type Description
data Uint8Array The data to decompress
opts? InflateOptions The decompression options

Returns

Uint8Array

The decompressed version of the data

deflate

▸ deflate(data, opts, cb): 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

A function that can be used to immediately terminate the compression

▸ deflate(data, cb): 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, opts?): 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

The deflated version of the data

gunzip

▸ gunzip(data, opts, cb): 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

A function that can be used to immediately terminate the decompression

▸ gunzip(data, cb): 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

A function that can be used to immediately terminate the decompression

gunzipSync

▸ gunzipSync(data, opts?): Uint8Array

Expands GZIP data

Parameters

Name Type Description
data Uint8Array The data to decompress
opts? GunzipOptions The decompression options

Returns

Uint8Array

The decompressed version of the data

gzip

▸ gzip(data, opts, cb): 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

A function that can be used to immediately terminate the compression

▸ gzip(data, cb): 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

A function that can be used to immediately terminate the decompression

gzipSync

▸ gzipSync(data, opts?): Uint8Array

Compresses data with GZIP

Parameters

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

Returns

Uint8Array

The gzipped version of the data

inflate

▸ inflate(data, opts, cb): 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

A function that can be used to immediately terminate the decompression

▸ inflate(data, cb): 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

A function that can be used to immediately terminate the decompression

inflateSync

▸ inflateSync(data, opts?): Uint8Array

Expands DEFLATE data with no wrapper

Parameters

Name Type Description
data Uint8Array The data to decompress
opts? InflateOptions The decompression options

Returns

Uint8Array

The decompressed version of the data

strFromU8

▸ strFromU8(dat, latin1?): string

Converts a Uint8Array to a string

Parameters

Name Type Description
dat Uint8Array The data to decode to string
latin1? boolean Whether or not to interpret the data as Latin-1. This should not need to be true unless encoding to binary string.

Returns

string

The original UTF-8/Latin-1 string

strToU8

▸ strToU8(str, latin1?): Uint8Array

Converts a string into a Uint8Array for use with compression/decompression methods

Parameters

Name Type Description
str string The string to encode
latin1? boolean Whether or not to interpret the data as Latin-1. This should not need to be true unless decoding a binary string.

Returns

Uint8Array

The string encoded in UTF-8/Latin-1 binary

unzip

▸ unzip(data, opts, cb): AsyncTerminable

Asynchronously decompresses a ZIP archive

Parameters

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

Returns

AsyncTerminable

A function that can be used to immediately terminate the unzipping

▸ unzip(data, cb): 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

A function that can be used to immediately terminate the unzipping

unzipSync

▸ unzipSync(data, opts?): Unzipped

Synchronously decompresses a ZIP archive. Prefer using unzip for better performance with more than one file.

Parameters

Name Type Description
data Uint8Array The raw compressed ZIP file
opts? UnzipOptions The ZIP extraction options

Returns

Unzipped

The decompressed files

unzlib

▸ unzlib(data, opts, cb): AsyncTerminable

Asynchronously expands Zlib data

Parameters

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

Returns

AsyncTerminable

A function that can be used to immediately terminate the decompression

▸ unzlib(data, cb): 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

A function that can be used to immediately terminate the decompression

unzlibSync

▸ unzlibSync(data, opts?): Uint8Array

Expands Zlib data

Parameters

Name Type Description
data Uint8Array The data to decompress
opts? UnzlibOptions The decompression options

Returns

Uint8Array

The decompressed version of the data

zip

▸ zip(data, opts, cb): 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

A function that can be used to immediately terminate the compression

▸ zip(data, cb): 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

A function that can be used to immediately terminate the compression

zipSync

▸ zipSync(data, opts?): Uint8Array

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

Parameters

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

Returns

Uint8Array

The generated ZIP archive

zlib

▸ zlib(data, opts, cb): 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, cb): 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

A function that can be used to immediately terminate the compression

zlibSync

▸ zlibSync(data, opts?): Uint8Array

Compress data with Zlib

Parameters

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

Returns

Uint8Array

The zlib-compressed version of the data