Skip to content

Update example of creating a pipe chain on readable #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reillyeon merged 1 commit into from
Feb 22, 2025
Merged

Update example of creating a pipe chain on readable #210

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -949,11 +949,24 @@ <h2>
}
}

const lineReader = port.readable
.pipeThrough(new TextDecoderStream())
const decoder = new TextDecoderStream();
const streamClosed = port.readable.pipeTo(decoder.writable);
const lineReader = decoder.readable
.pipeThrough(new TransformStream(new LineBreakTransformer()))
.getReader();
</pre>
<p>
As in [[[#close-example]]] the pipe chain cannot be constructed
using only `pipeThrough()`. It is necessary to use `pipeTo()` when
attaching the first {{TransformStream}} to the {{SerialPort}} so
that you can wait for the pipe chain to be closed when you want to
close the port.
</p>
<pre class="js">
lineReader.cancel();
await streamClosed;
await port.close();
</pre>
<p>
Some other ways of encoding message boundaries are to prefix each
message with its length or to wait a defined length of time before
Expand Down Expand Up @@ -1573,7 +1586,7 @@ <h4>
<h3>
<dfn>close()</dfn> method
</h3>
<aside class="example">
<aside id="close-example" class="example">
<p>
When communication with the port is no longer required it can be
closed and the associated resources released by the system.
Expand Down
Loading