diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5dd87d8 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +# Changelog + +> **Tags:** +> - 💥 Breaking Change +> - 👓 Spec Compliance +> - 🚀 New Feature +> - 🐛 Bug Fix +> - 👎 Deprecation +> - 📝 Documentation +> - 🏠 Internal +> - 💅 Polish + +## v0.2.0 (2022-06-27) + +* 💥 This package is now ESM-only, and uses ES2020 syntax. ([#25](https://github.com/MattiasBuelens/remote-web-streams/issues/25), [#26](https://github.com/MattiasBuelens/remote-web-streams/pull/26)) + +## v0.1.0 (2018-07-15) + +* 🚀 Initial release. diff --git a/README.md b/README.md index ea99a53..0f2dd95 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,8 @@ The basic steps for setting up a pair of linked streams are: * a `ReadableStream` which will read chunks written by the linked `WritableStream` ```js // main.js -const { readable, writablePort } = new RemoteWebStreams.RemoteReadableStream(); +import { RemoteReadableStream } from 'remote-web-streams'; +const { readable, writablePort } = new RemoteReadableStream(); ``` 2. Transfer the `writablePort` to the other context, and instantiate the linked `WritableStream` in that context using `fromWritablePort`. @@ -83,6 +84,7 @@ const worker = new Worker('./worker.js'); worker.postMessage({ writablePort }, [writablePort]); // worker.js +import { fromWritablePort } from 'remote-web-streams'; self.onmessage = (event) => { const { writablePort } = event.data; const writable = RemoteWebStreams.fromWritablePort(writablePort); @@ -114,15 +116,15 @@ This is the complement to `RemoteReadableStream`: and instantiate the linked `ReadableStream` with `fromReadablePort` inside that context. ```js // main.js -const { writable, readablePort } = new RemoteWebStreams.RemoteWritableStream(); +import { RemoteWritableStream } from 'remote-web-streams'; worker.postMessage({ readablePort }, [readablePort]); const writer = writable.getWriter(); // ... // worker.js +import { fromReadablePort } from 'remote-web-streams'; self.onmessage = (event) => { const { readablePort } = event.data; - const writable = RemoteWebStreams.fromReadablePort(readablePort); const reader = readable.getReader(); // ... } @@ -149,7 +151,7 @@ To demonstrate these "remote transform streams", we set one up to solve the orig ```js // main.js -const { RemoteReadableStream, RemoteWritableStream } = RemoteWebStreams; +import { RemoteReadableStream, RemoteWritableStream } from 'remote-web-streams'; (async () => { const worker = new Worker('./worker.js'); // create a stream to send the input to the worker @@ -174,7 +176,7 @@ const { RemoteReadableStream, RemoteWritableStream } = RemoteWebStreams; })(); // worker.js -const { fromReadablePort, fromWritablePort } = RemoteWebStreams; +import { fromReadablePort, fromWritablePort } from 'remote-web-streams'; self.onmessage = async (event) => { // create the input and output streams from the transferred ports const { readablePort, writablePort } = event.data; diff --git a/docs/examples/page-array.html b/docs/examples/page-array.html index e7261a6..50b75c9 100644 --- a/docs/examples/page-array.html +++ b/docs/examples/page-array.html @@ -4,8 +4,6 @@ Processing an array inside a web page script - - @@ -20,7 +18,10 @@

 
-
-    
         
         
 
 
 
@@ -22,7 +20,10 @@
 
 

 
-
         
         
 
 
 
@@ -19,9 +18,11 @@
 
 

 
-
         
         
 
 
 
@@ -26,9 +25,11 @@
 
 

 
-
     
         
         
 
 
@@ -21,11 +20,13 @@
 
 

 
-