https://github.com/foo123/bytestream.js

Simple but versatile class to make reading, writing and parsing binary data easy
https://github.com/foo123/bytestream.js

binary-format binary-stream

Last synced: 7 months ago
JSON representation

Simple but versatile class to make reading, writing and parsing binary data easy

• Host: GitHub
• URL: https://github.com/foo123/bytestream.js
• Owner: foo123
• Created: 2025-05-27T15:12:25.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2025-06-03T13:25:51.000Z (8 months ago)
• Last Synced: 2025-06-03T23:46:07.621Z (8 months ago)
• Topics: binary-format, binary-stream
• Language: JavaScript
• Homepage:
• Size: 6.84 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# ByteStream.js

Simple but versatile class to make reading, writing and parsing binary data easy

**version 1.0.0 in progress**

Example

```js

const stream = new ByteStream();

(async function writer() {

    // can write to byte stream

    const writestream = new ByteStream();

    writestream.writeInt(-512, 'int16', 'BE');

    writestream.writeInt(262, 'int16', 'BE');

    writestream.writeUtf8(String.fromCodePoint(0x1f303));

    return writestream.bytes();

})().then(function(data) {

    function reader()

    {

        if (reader.pos >= data.length) return null;

        const pos = reader.pos, offset = 2;

        reader.pos += offset;

        return data.slice(pos, pos+offset); // simulate data coming in progressively

    }

    reader.pos = 0;

    setTimeout(function read() {

        const chunk = reader();

        if (!chunk)

        {

            // if no more data, signal to the stream that we finished

            stream.finish();

        }

        else

        {

            // as long as reader has new data, add them to the stream

            stream.add(chunk);

            setTimeout(read, 100);

        }

    }, 100);

});

(async function test() {

    // read from byte stream asynchronously, while new data arrive

    console.log(await stream.readInt('int16', 'BE'), -512);

    console.log(await stream.readInt('int16', 'BE'), 262);

    console.log(await stream.readUtf8(1), String.fromCodePoint(0x1f303));

})().then(() => {console.log('--EOF--')});

```