graalvm/elide.runtime.intrinsics.js.node/ZlibAPI

ZlibAPI

Node API: Zlib

Implements routines for compressing and decompressing data with various algorithms, including Deflate, Gzip, Zip, and Brotli. This API is available through the zlib module.

Properties

constants

abstract val constants: NodeZlibConstants

Returns an object containing commonly-used constants exposed by the underlying zlib implementation.

Functions

brotliCompress

abstract fun brotliCompress(buffer: ZlibBuffer, options: BrotliOptions? = null, cbk: CompressCallback)

open fun brotliCompress(buffer: Value, options: Value? = null, cbk: Value)

Asynchronously compresses the given buffer using the Brotli algorithm; apply the provided options, or use defaults if no options are specified.

brotliCompressSync

abstract fun brotliCompressSync(buffer: ZlibBuffer, options: BrotliOptions? = null): ZlibBuffer

open fun brotliCompressSync(buffer: Value?, options: Value? = null): ZlibBuffer

Synchronously compresses the given buffer using the Brotli algorithm; apply the provided options, or use defaults if no options are specified.

brotliDecompress

abstract fun brotliDecompress(buffer: ZlibBuffer, options: BrotliOptions? = null, cbk: CompressCallback)

open fun brotliDecompress(buffer: Value, options: Value? = null, cbk: Value)

Asynchronously decompresses the given buffer using the Brotli algorithm; apply the provided options, or use defaults if no options are specified.

brotliDecompressSync

abstract fun brotliDecompressSync(buffer: ZlibBuffer, options: BrotliOptions? = null): ZlibBuffer

open fun brotliDecompressSync(buffer: Value?, options: Value? = null): ZlibBuffer

Synchronously decompresses the given buffer using the Brotli algorithm; apply the provided options, or use defaults if no options are specified.

crc32

abstract fun crc32(data: ByteArray, value: ULong): Long

Calculates the CRC32 checksum of the given data.

open fun crc32(data: Value?, value: Value? = null): Long

Calculates the CRC32 checksum of the given data; this method variant operates on foreign Value instances.

createBrotliCompress

abstract fun createBrotliCompress(options: BrotliOptions): BrotliCompress

open fun createBrotliCompress(options: Value? = null): BrotliCompress

Creates an instance of the BrotliCompress object, using the provided options, if any.

createBrotliDecompress

abstract fun createBrotliDecompress(options: BrotliOptions): BrotliDecompress

open fun createBrotliDecompress(options: Value? = null): BrotliDecompress

Creates an instance of the BrotliDecompress object, using the provided options, if any.

createDeflate

abstract fun createDeflate(options: ZlibOptions): Deflate

open fun createDeflate(options: Value? = null): Deflate

Creates an instance of the Deflate object, using the provided options, if any.

createInflate

abstract fun createInflate(options: ZlibOptions): Inflate

open fun createInflate(options: Value? = null): Inflate

Creates an instance of the Inflate object, using the provided options, if any.

createUnzip

abstract fun createUnzip(options: ZlibOptions): Unzip

open fun createUnzip(options: Value? = null): Unzip

Creates an instance of the Unzip object, using the provided options, if any.

deflate

abstract fun deflate(buffer: ZlibBuffer, options: ZlibOptions? = null, cbk: CompressCallback)

open fun deflate(buffer: Value, options: Value? = null, cbk: Value)

Asynchronously compresses the given buffer using the DEFLATE algorithm; apply the provided options, or use defaults if no options are specified.

deflateSync

abstract fun deflateSync(buffer: ZlibBuffer, options: ZlibOptions? = null): ZlibBuffer

open fun deflateSync(buffer: Value?, options: Value? = null): ZlibBuffer

Synchronously compresses the given buffer using the DEFLATE algorithm; apply the provided options, or use defaults if no options are specified.

gunzip

abstract fun gunzip(buffer: ZlibBuffer, options: ZlibOptions? = null, cbk: CompressCallback)

open fun gunzip(buffer: Value, options: Value? = null, cbk: Value)

Asynchronously decompresses the given buffer using the gunzip algorithm; apply the provided options, or use defaults if no options are specified.

gunzipSync

abstract fun gunzipSync(buffer: ZlibBuffer, options: ZlibOptions? = null): ZlibBuffer

open fun gunzipSync(buffer: Value?, options: Value? = null): ZlibBuffer

Synchronously decompresses the given buffer using the GZIP algorithm; apply the provided options, or use defaults if no options are specified.

gzip

abstract fun gzip(buffer: ZlibBuffer, options: ZlibOptions? = null, cbk: CompressCallback)

open fun gzip(buffer: Value, options: Value? = null, cbk: Value)

Asynchronously compresses the given buffer using the gzip algorithm; apply the provided options, or use defaults if no options are specified.

gzipSync

abstract fun gzipSync(buffer: ZlibBuffer, options: ZlibOptions? = null): ZlibBuffer

open fun gzipSync(buffer: Value?, options: Value? = null): ByteBuffer

Synchronously compresses the given buffer using the GZIP algorithm; apply the provided options, or use defaults if no options are specified.

inflate

abstract fun inflate(buffer: ZlibBuffer, options: ZlibOptions? = null, cbk: CompressCallback)

open fun inflate(buffer: Value, options: Value? = null, cbk: Value)

Asynchronously decompresses the given buffer using the DEFLATE algorithm; apply the provided options, or use defaults if no options are specified.

inflateSync

abstract fun inflateSync(buffer: ZlibBuffer, options: ZlibOptions? = null): ZlibBuffer

open fun inflateSync(buffer: Value?, options: Value? = null): ZlibBuffer

Synchronously decompresses the given buffer using the DEFLATE algorithm; apply the provided options, or use defaults if no options are specified.

unzip

abstract fun unzip(buffer: ZlibBuffer, options: ZlibOptions? = null, cbk: CompressCallback)

open fun unzip(buffer: Value, options: Value? = null, cbk: Value)

Asynchronously decompresses the given buffer using the zip algorithm; apply the provided options, or use defaults if no options are specified.

unzipSync

abstract fun unzipSync(buffer: ZlibBuffer, options: ZlibOptions? = null): ZlibBuffer

open fun unzipSync(buffer: Value?, options: Value? = null): ZlibBuffer

Synchronously decompresses the given buffer using the Zip algorithm; apply the provided options, or use defaults if no options are specified.