francisrstokes/construct-js

🛠️A library for creating byte level data structures.

construct-js's Issues

TypeScript Declaration File

Document the types.

Question: Does it work with floats?

Thank you for the library. I was wondering to know if this library works with floats or is a way to serialize single or double precision numbers and restore them for later ( with some loss of precision).

fromBuffer()?

First, this looks amazing and is just what I need to keep my binary structs sane!

Is there a `fromBuffer()? If I receive one of these in Buffer form, is there a way to load it into a Struct? I see a few get methods, but not any set ones.

New uInt64 field

Would be great to have a Int64/uInt64-Field. We would read it from the database as a string that contains a 64-bit number (f.e. "9223372036854775807") and it is somehow converted into a 64 bit long buffer that contains the value 7FFF,FFFF,FFFF,FFFF.

Get rid of boolean endianness flag in User API

and instead expose functions like U16LE and S32BE instead. The internal API can stay the same.

Typing the added properties

Hello, I'm wondering if you would consider typing the added fields in TS, I just made an experiment here below as an example:

In this way, we can write the following code

const struct = new Struct()
.field("hello", "world")
.field("foo", "bar")
.build();

struct.hello // okay -> world
struct.foo // okay -> bar
struct.nope // error

This is just to show a possible way of adding properties by chaining to a type using ts.

Version TS>=5

Equivalent code for Version TS<5

"Word" size + naming

Using a Word as 16-bits is a bit outdated and I think it can be more generalized + future proof. Is it possible to rename it to something like iWord16 or uWord32 to differentiate between signed and unsigned and specify the total number of bits being used?

Null terminated strings

(using this issue to record notes/ideas)

Just like RawString, but with the extra byte.

Switch from using Buffer -> ArrayBuffer

If ArrayBuffer is used, construct-js could be used in the browser as well.