miniSphere
Options
All
  • Public
  • Public/Protected
  • All
Menu

Provides functions for data compression and decompression.

Index

Functions

Functions

deflate

  • deflate(data: ArrayBuffer | ArrayBufferView, level?: number): ArrayBuffer

  • Compress data using the DEFLATE compression algorithm.

    Parameters

    • data: ArrayBuffer | ArrayBufferView

      A buffer containing the data to compress.

    • Optional level: number

      Compression level between 0 (no compression) and 9 (max).

    Returns ArrayBuffer

    An ArrayBuffer containing the compressed data.

inflate

  • inflate(data: ArrayBuffer | ArrayBufferView, maxSize?: number): ArrayBuffer

  • Uncompress data that was previously compressed using Z.deflate, with optional "inflate bomb" protection.

    Parameters

    • data: ArrayBuffer | ArrayBufferView

      A buffer containing some data compressed using deflate.

    • Optional maxSize: number

      The maximum allowed size of the data after inflation, in bytes.

    Returns ArrayBuffer

    An ArrayBuffer containing the uncompressed data.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc