Skip to content

Commit

Permalink
Add note about teed streams not connected to original stream to docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
codedread committed Jan 10, 2024
1 parent 983a720 commit 18f4ceb
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/bitjs.io.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,8 @@ pick up where you left off with the original stream.
const description = teedStream.skip(strOffset).readString(strLen);

const someOtherVal = origStream.readNumber(4); // Bytes 8-11
```
```

Note that the teed stream is not "connected" to the original stream. If you push new bytes to the
original stream, the teed stream does not see them. If you find this behavior unexpected, please
file a bug.

0 comments on commit 18f4ceb

Please sign in to comment.