kotlin-pako/pako

Package-level declarations

Types

Link copied to clipboard
interface DeflateOptions
Link copied to clipboard
sealed interface Flush
Link copied to clipboard
interface Header
Link copied to clipboard
interface InflateOptions
Link copied to clipboard
Link copied to clipboard
sealed interface ReturnCode
Link copied to clipboard
sealed interface Strategy
Link copied to clipboard
sealed interface To

Properties

Link copied to clipboard

Functions

Link copied to clipboard
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.

Link copied to clipboard
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).

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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).

Link copied to clipboard
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.