Package-level declarations

Types

open class Deflate(options: DeflateOptions = definedExternally)

Generic JS-style wrapper for zlib calls. If you don't need streaming behaviour - use more simple functions: deflate, deflateRaw and gzip.

DeflateOptions

interface DeflateOptions

Flush

sealed interface Flush

Header

interface Header

Inflate

open class Inflate(options: InflateOptions = definedExternally)

Generic JS-style wrapper for zlib calls. If you don't need streaming behaviour - use more simple functions: inflate and inflateRaw.

InflateOptions

interface InflateOptions

InflateToStringOptions

interface InflateToStringOptions : InflateOptions

ReturnCode

sealed interface ReturnCode

Strategy

sealed interface Strategy

sealed interface To

Properties

string

val To.Companion.string: To

Functions

deflate

external fun deflate(data: ArrayBuffer, options: DeflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun deflate(data: Uint8Array<*>, options: DeflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun deflate(data: String, options: DeflateOptions = definedExternally): Uint8Array<ArrayBuffer>

Compress data with deflate algorithm and options.

deflateRaw

external fun deflateRaw(data: ArrayBuffer, options: DeflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun deflateRaw(data: Uint8Array<*>, options: DeflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun deflateRaw(data: String, options: DeflateOptions = definedExternally): Uint8Array<ArrayBuffer>

The same as deflate, but creates raw data, without wrapper (header and adler32 crc).

gzip

external fun gzip(data: ArrayBuffer, options: DeflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun gzip(data: Uint8Array<*>, options: DeflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun gzip(data: String, options: DeflateOptions = definedExternally): Uint8Array<ArrayBuffer>

The same as deflate, but create gzip wrapper instead of deflate one.

inflate

external fun inflate(data: ArrayBuffer, options: InflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun inflate(data: ArrayBuffer, options: InflateToStringOptions): String

external fun inflate(data: Uint8Array<*>, options: InflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun inflate(data: Uint8Array<*>, options: InflateToStringOptions): String

Decompress data with inflate/ungzip and options. Autodetect format via wrapper header by default. That's why we don't provide separate ungzip method.

inflateRaw

external fun inflateRaw(data: ArrayBuffer, options: InflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun inflateRaw(data: ArrayBuffer, options: InflateToStringOptions): String

external fun inflateRaw(data: Uint8Array<*>, options: InflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun inflateRaw(data: Uint8Array<*>, options: InflateToStringOptions): String

The same as inflate, but creates raw data, without wrapper (header and adler32 crc).

unzip

external fun unzip(data: ArrayBuffer, options: InflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun unzip(data: ArrayBuffer, options: InflateToStringOptions): String

external fun unzip(data: Uint8Array<*>, options: InflateOptions = definedExternally): Uint8Array<ArrayBuffer>

external fun unzip(data: Uint8Array<*>, options: InflateToStringOptions): String

Just shortcut to inflate, because it autodetects format by header.content. Done for convenience.