yetangitu/bitjs
1
0
Fork 0
mirror of https://github.com/codedread/bitjs synced 2025-10-03 09:39:16 +02:00
Code Issues Releases Wiki Activity

Better explanation for tee()

Browse source
This commit is contained in:
Jeff Schiller 2024-01-04 22:47:41 +09:00
parent 004cd8731a
commit 79c289afa1
1 changed files with 10 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/bitjs.io.md
View file

@ -69,13 +69,16 @@ the byte stream by using `someByteStream.push(nextBytesAsAnArrayBuffer)`.
If you have a need to seek ahead to a different section of the stream of bytes, and want to later
return to where you left off, you should use `tee()` method to make a copy of the ByteStream. This
will let you seek to the appropriate spot to grab some bytes.
will let you seek to the appropriate spot to grab some bytes using the teed stream, while you can
pick up where you left off with the original stream.
```javascript
const byteStream = new ByteStream(someArrayBuffer);
const strLen = byteStream.readNumber(4); // Bytes 0-3.
const strOffset = byteStream.readNumber(4); // Bytes 4-7.
// Grab bytes at that offset...
const description = byteStream.tee().skip(offset).readString(strLen);
const someOtherVal = byteStream.readNumber(4); // Bytes 8-11
const origStream = new ByteStream(someArrayBuffer);
const strLen = origStream.readNumber(4); // Bytes 0-3.
const strOffset = origStream.readNumber(4); // Bytes 4-7.
const teedStream = origStream.tee();
const description = teedStream.skip(strOffset).readString(strLen);
const someOtherVal = origStream.readNumber(4); // Bytes 8-11
```