Skip to content

fisker/web-compression

Repository files navigation

web-compression

Npm Version MIT License Coverage

A tiny (de)compression library.

Install

yarn add web-compression

Usage

import {compress, decompress} from 'web-compression'

const compressed = await compress('fisker').arrayBuffer()
console.log(compressed)
//=> ArrayBuffer {
//   [Uint8Contents]: <1f 8b 08 00 00 00 00 00 00 0a 4b cb 2c ce 4e 2d 02 00 99 fc c4 60 06 00 00 00>,
//   byteLength: 26
// }

const decompressed = decompress(compressed)
console.log(await decompressed.text())
//=> 'fisker'

API

(de)compress(body, format?)

Returns an Response with (de)compressed data.

body

Type: Blob | ArrayBuffer | TypedArray | DataView | string

See body argument of Response.

format

Type: 'gzip' | 'deflate' | 'deflate-raw' | 'brotli'

See format argument of CompressionStream and DecompressionStream.

About

A tiny (de)compression library.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors