1.0.8 • Published 2 years ago

byte-array-sequential v1.0.8

Weekly downloads
169
License
MIT
Repository
github
Last release
2 years ago

Incremental Binary array writer/reader

Simple way to write binary data and later read it in same order.

Where is it useful?

When:

  • Storing data in simple formats (like json) takes too much disc/network etc space.

Install

npm install byte-array-sequential

Example

const writer = new BinaryArrayWriter();
writer.writeInt8(10);
writer.writeBooleans(true, false, false, true, true, false, true, true);

const writer2 = new BinaryArrayWriter();
writer2.writeInt16(10000);
writer.writeWriter(writer2);

const string = writer.export();

const reader = BinaryArrayReader.import(string);
expect(reader.readInt8()).toEqual(10);

const booleans = reader.readBooleans();
expect(booleans).toEqual([true, false, false, true, true, false, true, true]);

const reader2 = reader.readReader();
expect(reader2.readInt16()).toEqual(10000);

Weakness of this approach

What ever you write you later need to read back in same order or results will be corrupted. It would be recommended to add versioning to it, so you can read older and newer versions. Start thinking about binary structure only when you really need it and your overall structure is relatively stable. (you can easily store it as json for example).

License

MIT - Do what ever you want with it. If you found it useful, let me know :)

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago