Skip to content

Commit faa6ce6

Browse files
committed
Briefly document the streaming API
1 parent 1b48dc5 commit faa6ce6

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ In all builds (after waiting for the exported promise in browsers) the module ex
2525
* `compress(Buffer, [options])` - compresses a buffer using Brotli, returning the compressed buffer. An optional options object can be provided. The only currently supported option is `quality`: a number between 1 and 11.
2626
* `decompress(Buffer)` - decompresses a buffer using Brotli, returning the original raw data.
2727

28+
For advanced use data-streaming use cases, `CompressStream` and `DecompressStream` classes for streaming compression are also available. See [the tests](https://github.com/httptoolkit/brotli-wasm/blob/main/test/brotli.spec.ts) for example usage.
29+
2830
### Usage
2931

3032
In node.js:

0 commit comments

Comments
 (0)