typed-buffer-struct

This is a package which helps the user to create a Struct with automatic Buffer creation.

How to use

1// import it first
2import newStruct from "typed-buffer-struct";
3
4// then, create typed structs with it!
5const sStats = newStruct()
6  /* 0 to  3 */ .uint("level")
7  /* 4 to  7 */ .uint("attack")
8  /* 8 to 11 */ .uint("defense")
9  .build(); // total of 12 bytes
10
11const sCharacter = newStruct()
12  /*  0 to 11 */ .string("name", 12)
13  /* 12 to 23 */ .struct("stats", sStats)
14  .build(); // total of 24 bytes
15
16const sAccount = newStruct()
17  /* 0 to 95 */ .array("characters", 4, (b) => b.struct(sCharacter))
18  .build(); // total of 96 bytes
19
20// now, lets create a new account
21const account = sAccount();
22
23// lets add a name to the second and third array indexes
24account.characters[1].name = "Amazing!";
25account.characters[2].name = "Testing";
26
27// and finally, lets get the Buffer
28console.log("Account buffer:", account.buffer);
29
30/*
31OUTPUT:
320: 000000000000000000000000000000000000000000000000
331: 416d617a696e672100000000000000000000000000000000
342: 54657374696e670000000000000000000000000000000000
353: 000000000000000000000000000000000000000000000000
36(here I divided the output in 4 sections, just to show the 4 characters in the account)
37*/