@itk-wasm/compress-stringify v3.3.1

@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 {
  imageToJson,
  jsonToImage,
  meshToJson,
  jsonToMesh,
  polyDataToJson,
  jsonToPolyData,
  compressStringify,
  parseStringDecompress,
  setPipelinesBaseUrl,
  getPipelinesBaseUrl,
} from "@itk-wasm/compress-stringify"

Functions

imageToJson

Compress and encode an itk-wasm Image into a JSON compatible object.

async function imageToJson(
  image: Image,
  options: ImageToJsonOptions = {}
): Promise<ImageToJsonResult>

ImageToJsonOptions interface:

ImageToJsonResult interface:

jsonToImage

Decode and decompress an itk-wasm Image JSON, binary data compressed and converted to a string.

async function jsonToImage(
  encoded: ImageJson,
  options: JsonToImageOptions = {}
): Promise<JsonToImageResult>

JsonToImageOptions interface:

JsonToImageResult interface:

meshToJson

Compress and encode an itk-wasm Mesh into a JSON compatible object.

async function meshToJson(
  mesh: Mesh,
  options: MeshToJsonOptions = {}
): Promise<MeshToJsonResult>

MeshToJsonOptions interface:

MeshToJsonResult interface:

jsonToMesh

Decode and decompress an itk-wasm Mesh JSON, binary data compressed and converted to a string.

async function jsonToMesh(
  encoded: MeshJson,
  options: JsonToMeshOptions = {}
): Promise<JsonToMeshResult>

JsonToMeshOptions interface:

JsonToMeshResult interface:

polyDataToJson

Compress and encode an itk-wasm PolyData into a JSON compatible object.

async function polyDataToJson(
  polyData: PolyData,
  options: PolyDataToJsonOptions = {}
): Promise<PolyDataToJsonResult>

PolyDataToJsonOptions interface:

PolyDataToJsonResult interface:

jsonToPolyData

Decode and decompress an itk-wasm PolyData JSON compatible object.

async function jsonToPolyData(
  encoded: PolyDataJson,
  options: JsonToPolyDataOptions = {}
): Promise<JsonToPolyDataResult>

JsonToPolyDataOptions interface:

JsonToPolyDataResult interface:

compressStringify

Given a binary, compress and optionally base64 encode.

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

CompressStringifyOptions interface:

CompressStringifyResult interface:

parseStringDecompress

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

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

ParseStringDecompressOptions interface:

ParseStringDecompressResult interface:

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 {
  imageToJsonNode,
  jsonToImageNode,
  meshToJsonNode,
  jsonToMeshNode,
  polyDataToJsonNode,
  jsonToPolyDataNode,
  compressStringifyNode,
  parseStringDecompressNode,
} from "@itk-wasm/compress-stringify"

imageToJsonNode

Compress and encode an itk-wasm Image into a JSON compatible object.

async function imageToJsonNode(image: Image): Promise<ImageToJsonNodeResult>

ImageToJsonNodeResult interface:

jsonToImageNode

Decode and decompress an itk-wasm Image JSON compatible object.

async function jsonToImageNode(encoded: ImageJson): Promise<JsonToImageNodeResult>

JsonToImageNodeResult interface:

meshToJsonNode

Compress and encode an itk-wasm Mesh into a JSON compatible object.

async function meshToJsonNode(mesh: Mesh): Promise<MeshToJsonNodeResult>

MeshToJsonNodeResult interface:

jsonToMeshNode

Decode and decompress an itk-wasm Mesh JSON compatible object.

async function jsonToMeshNode(encoded: MeshJson): Promise<JsonToMeshNodeResult>

JsonToMeshNodeResult interface:

polyDataToJsonNode

Compress and encode an itk-wasm PolyData into a JSON compatible object.

async function polyDataToJsonNode(polyData: PolyData): Promise<PolyDataToJsonNodeResult>

PolyDataToJsonNodeResult interface:

jsonToPolyDataNode

Decode and decompress an itk-wasm PolyData JSON string.

async function jsonToPolyDataNode(encoded: PolyDataJson): Promise<JsonToPolyDataNodeResult>

JsonToPolyDataNodeResult interface:

compressStringifyNode

Given a binary, compress and optionally base64 encode.

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

CompressStringifyNodeOptions interface:

CompressStringifyNodeResult interface:

parseStringDecompressNode

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

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

ParseStringDecompressNodeOptions interface:

ParseStringDecompressNodeResult interface: