Package-level declarations

Types

Link copied to clipboard
sealed external interface BrotliCompress : Transform, Zlib
Link copied to clipboard
sealed external interface BrotliDecompress : Transform, Zlib
Link copied to clipboard
sealed external interface BrotliOptions
Link copied to clipboard
sealed external interface BrotliOptionsParams
Link copied to clipboard
typealias CompressCallback = (error: JsError?, result: Buffer) -> Unit
Link copied to clipboard
sealed external interface Deflate : Transform, Zlib, ZlibReset, ZlibParams
Link copied to clipboard
sealed external interface DeflateRaw : Transform, Zlib, ZlibReset, ZlibParams
Link copied to clipboard
sealed external interface Gunzip : Transform, Zlib
Link copied to clipboard
sealed external interface Gzip : Transform, Zlib
Link copied to clipboard
sealed external interface Inflate : Transform, Zlib, ZlibReset
Link copied to clipboard
sealed external interface InflateRaw : Transform, Zlib, ZlibReset
Link copied to clipboard
typealias InputType = Any
Link copied to clipboard
sealed external interface Unzip : Transform, Zlib
Link copied to clipboard
sealed external interface Zlib
Link copied to clipboard
sealed external interface ZlibOptions
Link copied to clipboard
sealed external interface ZlibParams
Link copied to clipboard
sealed external interface ZlibReset

Properties

Link copied to clipboard
external val Z_ASCII: Double
Link copied to clipboard
Link copied to clipboard
external val Z_BEST_SPEED: Double
Link copied to clipboard
external val Z_BINARY: Double
Link copied to clipboard
external val Z_BLOCK: Double
Link copied to clipboard
external val Z_BUF_ERROR: Double
Link copied to clipboard
external val Z_DATA_ERROR: Double
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external val Z_DEFLATED: Double
Link copied to clipboard
external val Z_ERRNO: Double
Link copied to clipboard
external val Z_FILTERED: Double
Link copied to clipboard
external val Z_FINISH: Double
Link copied to clipboard
external val Z_FIXED: Double
Link copied to clipboard
external val Z_FULL_FLUSH: Double
Link copied to clipboard
external val Z_HUFFMAN_ONLY: Double
Link copied to clipboard
external val Z_MEM_ERROR: Double
Link copied to clipboard
external val Z_NEED_DICT: Double
Link copied to clipboard
external val Z_NO_COMPRESSION: Double
Link copied to clipboard
external val Z_NO_FLUSH: Double
Link copied to clipboard
external val Z_OK: Double
Link copied to clipboard
external val Z_PARTIAL_FLUSH: Double
Link copied to clipboard
external val Z_RLE: Double
Link copied to clipboard
external val Z_STREAM_END: Double
Link copied to clipboard
external val Z_STREAM_ERROR: Double
Link copied to clipboard
external val Z_SYNC_FLUSH: Double
Link copied to clipboard
external val Z_TEXT: Double
Link copied to clipboard
external val Z_TREES: Double
Link copied to clipboard
external val Z_UNKNOWN: Double
Link copied to clipboard
external val Z_VERSION_ERROR: Double

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): Buffer

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): Buffer

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
external fun crc32(data: Buffer, 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 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): Buffer

Compress a chunk of data with DeflateRaw.

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

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): Buffer

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): Buffer

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): Buffer

Decompress a chunk of data with InflateRaw.

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

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): Buffer

Decompress a chunk of data with Unzip.