Skip to content

Commit 18f4ceb

Browse files
committed
Add note about teed streams not connected to original stream to docs.
1 parent 983a720 commit 18f4ceb

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/bitjs.io.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,8 @@ pick up where you left off with the original stream.
8181
const description = teedStream.skip(strOffset).readString(strLen);
8282

8383
const someOtherVal = origStream.readNumber(4); // Bytes 8-11
84-
```
84+
```
85+
86+
Note that the teed stream is not "connected" to the original stream. If you push new bytes to the
87+
original stream, the teed stream does not see them. If you find this behavior unexpected, please
88+
file a bug.

0 commit comments

Comments
 (0)