@itk-wasm/compress-stringify

Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.

👨‍💻 Live API Demo ✨

🕮 Documentation 📚

Installation

npm install @itk-wasm/compress-stringify

Usage

Browser interface

Import:

import {
  compressStringify,
  parseStringDecompress,
  setPipelinesBaseUrl,
  getPipelinesBaseUrl,
} from "@itk-wasm/compress-stringify"

Functions

compressStringify

Given a binary, compress and optionally base64 encode.

async function compressStringify(
  input: Uint8Array,
  options: CompressStringifyOptions = {}
) : Promise<CompressStringifyResult>

Parameter	Type	Description
input	Uint8Array	Input binary

CompressStringifyOptions interface:

Property	Type	Description
stringify	boolean	Stringify the output
compressionLevel	number	Compression level, typically 1-9
dataUrlPrefix	string	dataURL prefix
webWorker	null or Worker or boolean	WebWorker for computation. Set to null to create a new worker. Or, pass an existing worker. Or, set to false to run in the current thread / worker.
noCopy	boolean	When SharedArrayBuffer's are not available, do not copy inputs.

CompressStringifyResult interface:

Property	Type	Description
output	Uint8Array	Output compressed binary
webWorker	Worker	WebWorker used for computation.

parseStringDecompress

Given a binary or string produced with compress-stringify, decompress and optionally base64 decode.

async function parseStringDecompress(
  input: Uint8Array,
  options: ParseStringDecompressOptions = {}
) : Promise<ParseStringDecompressResult>

Parameter	Type	Description
input	Uint8Array	Compressed input

ParseStringDecompressOptions interface:

Property	Type	Description
parseString	boolean	Parse the input string before decompression
webWorker	null or Worker or boolean	WebWorker for computation. Set to null to create a new worker. Or, pass an existing worker. Or, set to false to run in the current thread / worker.
noCopy	boolean	When SharedArrayBuffer's are not available, do not copy inputs.

ParseStringDecompressResult interface:

Property	Type	Description
output	Uint8Array	Output decompressed binary
webWorker	Worker	WebWorker used for computation.

setPipelinesBaseUrl

Set base URL for WebAssembly assets when vendored.

function setPipelinesBaseUrl(
  baseUrl: string | URL
) : void

getPipelinesBaseUrl

Get base URL for WebAssembly assets when vendored.

function getPipelinesBaseUrl() : string | URL

Node interface

Import:

import {
  compressStringifyNode,
  parseStringDecompressNode,
} from "@itk-wasm/compress-stringify"

compressStringifyNode

Given a binary, compress and optionally base64 encode.

async function compressStringifyNode(
  input: Uint8Array,
  options: CompressStringifyNodeOptions = {}
) : Promise<CompressStringifyNodeResult>

Parameter	Type	Description
input	Uint8Array	Input binary

CompressStringifyNodeOptions interface:

Property	Type	Description
stringify	boolean	Stringify the output
compressionLevel	number	Compression level, typically 1-9
dataUrlPrefix	string	dataURL prefix

CompressStringifyNodeResult interface:

Property	Type	Description
output	Uint8Array	Output compressed binary

parseStringDecompressNode

Given a binary or string produced with compress-stringify, decompress and optionally base64 decode.

async function parseStringDecompressNode(
  input: Uint8Array,
  options: ParseStringDecompressNodeOptions = {}
) : Promise<ParseStringDecompressNodeResult>

Parameter	Type	Description
input	Uint8Array	Compressed input

ParseStringDecompressNodeOptions interface:

Property	Type	Description
parseString	boolean	Parse the input string before decompression

ParseStringDecompressNodeResult interface:

Property	Type	Description
output	Uint8Array	Output decompressed binary