Arjun Barrett
55c38eb5e2
v0.1.0
|
5 years ago | |
|---|---|---|
| .. | ||
| interfaces | 5 years ago | |
| README.md | 5 years ago | |
README.md
fflate
Index
Interfaces
- AsyncDeflateOptions
- AsyncGunzipOptions
- AsyncGzipOptions
- AsyncInflateOptions
- AsyncUnzlibOptions
- AsyncZlibOptions
- DeflateOptions
- GzipOptions
- ZlibOptions
Type aliases
Functions
- decompress
- decompressSync
- deflate
- deflateSync
- gunzip
- gunzipSync
- gzip
- gzipSync
- inflate
- inflateSync
- unzlib
- unzlibSync
- zlib
- zlibSync
Type aliases
FlateCallback
Ƭ FlateCallback: (err: Error,data: Uint8Array) => unknown
Callback for asynchronous comrpession methods
param Any error that occurred
param The resulting data. Only present if err is null
Functions
decompress
▸ decompress(data: Uint8Array, opts: AsyncInflateOptions, cb: FlateCallback): void
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: void
▸ decompress(data: Uint8Array, cb: FlateCallback): void
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: void
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): void
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: void
▸ deflate(data: Uint8Array, cb: FlateCallback): void
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: void
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): void
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: void
▸ gunzip(data: Uint8Array, cb: FlateCallback): void
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: void
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): void
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: void
▸ gzip(data: Uint8Array, cb: FlateCallback): void
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: void
▸ gzip(data: Uint8Array, opts: AsyncGzipOptions, cb: FlateCallback): void
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: void
▸ gzip(data: Uint8Array, cb: FlateCallback): void
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: void
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): void
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: void
▸ inflate(data: Uint8Array, cb: FlateCallback): void
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: void
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
unzlib
▸ unzlib(data: Uint8Array, opts: AsyncGunzipOptions, cb: FlateCallback): void
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: void
▸ unzlib(data: Uint8Array, cb: FlateCallback): void
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: void
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
zlib
▸ zlib(data: Uint8Array, opts: AsyncZlibOptions, cb: FlateCallback): void
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: void
▸ zlib(data: Uint8Array, cb: FlateCallback): void
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: void
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