ZipServices Class Reference

Description

Provides compression and decompression helpers.

Static Public Member Functions
static	compress (input, { level=6 }={})
static	decompress (input, { toString=false }={})

Function Documentation

compress()

compress ( input, { level=6 } = {} )

static

Compress anything.

• Single value (string / Uint8Array) → deflate, returns Uint8Array

Object { filename: data, ... } → ZIP archive, returns Uint8Array

Parameters

{(string|Uint8Array|Object.<string,(string|Uint8Array)>)}	input
{{	level: number }} [options]

Returns

{ApiResponse<Uint8Array>}

decompress()

decompress ( input, { toString=false } = {} )

static

Decompress anything.

• ZIP archive → { filename: Uint8Array, ... }
• Raw deflate → Uint8Array (pass toString: true to get a string back)

Parameters

{Uint8Array}	input
{{	toString: boolean }} options

Returns

{ApiResponse} data = decompressed result