Class ZLIBTextCompressor

[[ZLIBTextCompressor]] Performs the text compression and decompression using zlib

Index

Constructors

Methods

compress decompress

Constructors

constructor

new ZLIBTextCompressor(logger: Logger): ZLIBTextCompressor
Constructs an instance of [[ZLIBTextCompressor]]
Parameters
- logger: Logger
Returns ZLIBTextCompressor
- Defined in src/sdp/ZLIBTextCompressor.ts:24

Methods

compress

compress(text: string, dictionary: string): Uint8Array
Compresses the given text.

Note: The dictionary used during compression should be the same as that being used during decompression.
Parameters
- text: string
  the text that needs to be compressed
- dictionary: string
  that will be used to seed the compression library to improve compression's performance
Returns Uint8Array
a compressed text
- Defined in src/sdp/ZLIBTextCompressor.ts:37

decompress

decompress(compressedText: Uint8Array, dictionary: string): string
Decompresses the given text and returns the original text.

Note: The dictionary used during compression should be the same as that being used during decompression.
Parameters
- compressedText: Uint8Array
  that will be decompressed
- dictionary: string
  that will be used to seed the compression library to improve decompression's performance
Returns string
decompressed string
- Defined in src/sdp/ZLIBTextCompressor.ts:63