Skip to content

Commit 13a9089

Browse files
committed
doc: add remarks for compression to work in web worker
1 parent e66387a commit 13a9089

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,9 @@ or check the "[example]" folder in this repo
137137
| --------- | --------- | --------- | --------- | --------- | --------- |
138138
| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions
139139

140+
## Notes for compression to work in Web Worker
141+
The browser need to support "OffscreenCanvas" API in order to take advantage of non-blocking compression. If browser do not support "OffscreenCanvas" API, main thread is used instead. See https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas#browser_compatibility for browser compatibility of "OffscreenCanvas" API.
142+
140143
## IE support ##
141144
Promise API is being used in this library. If you need to support browser that do not support Promise like IE. You can include the Promise polyfill in your project.
142145

0 commit comments

Comments
 (0)