Package-level declarations

Types

Link copied to clipboard
external class BrotliCompress : Transform, Zlib
Link copied to clipboard
external class BrotliDecompress : Transform, Zlib
Link copied to clipboard
external interface BrotliOptions
Link copied to clipboard
typealias CompressCallback = (JsError?, result: NonSharedBuffer) -> Unit
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external class Gunzip : Transform, Zlib
Link copied to clipboard
external class Gzip : Transform, Zlib
Link copied to clipboard
external class Inflate : Transform, Zlib, ZlibReset
Link copied to clipboard
external class InflateRaw : Transform, Zlib, ZlibReset
Link copied to clipboard
typealias InputType = Any
Link copied to clipboard
external class Unzip : Transform, Zlib
Link copied to clipboard
external interface Zlib
Link copied to clipboard
external interface ZlibOptions
Link copied to clipboard
external interface ZlibParams
Link copied to clipboard
external interface ZlibReset
Link copied to clipboard
external class ZstdCompress : Transform, Zlib
Link copied to clipboard
external class ZstdDecompress : Transform, Zlib
Link copied to clipboard
external interface ZstdOptions

Functions

Link copied to clipboard
external fun brotliCompress(buf: InputType, callback: CompressCallback)
external fun brotliCompress(buf: InputType, options: BrotliOptions, callback: CompressCallback)
Link copied to clipboard
external fun brotliCompressSync(buf: InputType, options: BrotliOptions = definedExternally): NonSharedBuffer

Compress a chunk of data with BrotliCompress.

Link copied to clipboard
external fun brotliDecompress(buf: InputType, callback: CompressCallback)
external fun brotliDecompress(buf: InputType, options: BrotliOptions, callback: CompressCallback)
Link copied to clipboard
external fun brotliDecompressSync(buf: InputType, options: BrotliOptions = definedExternally): NonSharedBuffer

Decompress a chunk of data with BrotliDecompress.

Link copied to clipboard
external fun crc32(data: ArrayBufferView<*>, value: Number = definedExternally): Double
external fun crc32(data: String, value: Number = definedExternally): Double

Computes a 32-bit Cyclic Redundancy Check checksum of data. If value is specified, it is used as the starting value of the checksum, otherwise, 0 is used as the starting value.

Link copied to clipboard
external fun createBrotliCompress(options: BrotliOptions = definedExternally): BrotliCompress

Creates and returns a new BrotliCompress object.

Link copied to clipboard
external fun createBrotliDecompress(options: BrotliOptions = definedExternally): BrotliDecompress

Creates and returns a new BrotliDecompress object.

Link copied to clipboard
external fun createDeflate(options: ZlibOptions = definedExternally): Deflate

Creates and returns a new Deflate object.

Link copied to clipboard
external fun createDeflateRaw(options: ZlibOptions = definedExternally): DeflateRaw

Creates and returns a new DeflateRaw object.

Link copied to clipboard
external fun createGunzip(options: ZlibOptions = definedExternally): Gunzip

Creates and returns a new Gunzip object.

Link copied to clipboard
external fun createGzip(options: ZlibOptions = definedExternally): Gzip

Creates and returns a new Gzip object. See example.

Link copied to clipboard
external fun createInflate(options: ZlibOptions = definedExternally): Inflate

Creates and returns a new Inflate object.

Link copied to clipboard
external fun createInflateRaw(options: ZlibOptions = definedExternally): InflateRaw

Creates and returns a new InflateRaw object.

Link copied to clipboard
external fun createUnzip(options: ZlibOptions = definedExternally): Unzip

Creates and returns a new Unzip object.

Link copied to clipboard
external fun createZstdCompress(options: ZstdOptions = definedExternally): ZstdCompress

Creates and returns a new ZstdCompress object.

Link copied to clipboard
external fun createZstdDecompress(options: ZstdOptions = definedExternally): ZstdDecompress

Creates and returns a new ZstdDecompress object.

Link copied to clipboard
external fun deflate(buf: InputType, callback: CompressCallback)
external fun deflate(buf: InputType, options: ZlibOptions, callback: CompressCallback)
Link copied to clipboard
external fun deflateRaw(buf: InputType, callback: CompressCallback)
external fun deflateRaw(buf: InputType, options: ZlibOptions, callback: CompressCallback)
Link copied to clipboard
external fun deflateRawSync(buf: InputType, options: ZlibOptions = definedExternally): NonSharedBuffer

Compress a chunk of data with DeflateRaw.

Link copied to clipboard
external fun deflateSync(buf: InputType, options: ZlibOptions = definedExternally): NonSharedBuffer

Compress a chunk of data with Deflate.

Link copied to clipboard
external fun gunzip(buf: InputType, callback: CompressCallback)
external fun gunzip(buf: InputType, options: ZlibOptions, callback: CompressCallback)
Link copied to clipboard
external fun gunzipSync(buf: InputType, options: ZlibOptions = definedExternally): NonSharedBuffer

Decompress a chunk of data with Gunzip.

Link copied to clipboard
external fun gzip(buf: InputType, callback: CompressCallback)
external fun gzip(buf: InputType, options: ZlibOptions, callback: CompressCallback)
Link copied to clipboard
external fun gzipSync(buf: InputType, options: ZlibOptions = definedExternally): NonSharedBuffer

Compress a chunk of data with Gzip.

Link copied to clipboard
external fun inflate(buf: InputType, callback: CompressCallback)
external fun inflate(buf: InputType, options: ZlibOptions, callback: CompressCallback)
Link copied to clipboard
external fun inflateRaw(buf: InputType, callback: CompressCallback)
external fun inflateRaw(buf: InputType, options: ZlibOptions, callback: CompressCallback)
Link copied to clipboard
external fun inflateRawSync(buf: InputType, options: ZlibOptions = definedExternally): NonSharedBuffer

Decompress a chunk of data with InflateRaw.

Link copied to clipboard
external fun inflateSync(buf: InputType, options: ZlibOptions = definedExternally): NonSharedBuffer

Decompress a chunk of data with Inflate.

Link copied to clipboard
external fun unzip(buf: InputType, callback: CompressCallback)
external fun unzip(buf: InputType, options: ZlibOptions, callback: CompressCallback)
Link copied to clipboard
external fun unzipSync(buf: InputType, options: ZlibOptions = definedExternally): NonSharedBuffer

Decompress a chunk of data with Unzip.

Link copied to clipboard
external fun zstdCompress(buf: InputType, callback: CompressCallback)
external fun zstdCompress(buf: InputType, options: ZstdOptions, callback: CompressCallback)
Link copied to clipboard
external fun zstdCompressSync(buf: InputType, options: ZstdOptions = definedExternally): NonSharedBuffer

Compress a chunk of data with ZstdCompress.

Link copied to clipboard
external fun zstdDecompress(buf: InputType, callback: CompressCallback)
external fun zstdDecompress(buf: InputType, options: ZstdOptions, callback: CompressCallback)
Link copied to clipboard
external fun zstdDecompressSync(buf: InputType, options: ZstdOptions = definedExternally): NonSharedBuffer

Decompress a chunk of data with ZstdDecompress.