BVON

Serialize data into a buffer. Result size is smaller than BSON and JSON. Browser or NodeJS.

Table of Contents

• Installation
• Usage

Install

1npm i @neumatter/bvon

Usage

static (class) BVON.serialize:

Args [data: any, schema?: BVON.Schema]

Returns ByteView

without schema:

1import BVON, { UOID } from '@neumatter/bvon'
2
3const user = {
4  id: new UOID('2LD32T9NBPMF3YDQYLVANMG22A2J'),
5  name: {
6    first: 'Mike',
7    last: 'Williamson'
8  },
9  createdAt: new Date('2023-03-02T06:00:00.000Z'),
10  modifiedAt: new Date('2023-03-13T06:00:00.000Z'),
11  settings: {
12    theme: 'dark',
13    fontSize: 15,
14    formOfContact: 'text'
15  },
16  phone: '8889991234'
17}
18
19console.log(BVON.serialize(user))
20
21/*
22prints: <ByteView(216) 09 08 06 06 08 02 69 64 10 08 
231c 32 4c 44 33 32 54 39 4e 42 50 4d 46 33 59 44 51 59 
244c 56 41 4e 4d 47 32 32 41 32 4a 06 08 04 6e 61 6d 65 
2509 08 02 06 08 05 66 69 72 73 74 06 08 04 4d 69 6b 65 
2606 08 04 6c 61 73 74 06 08 0a 57 69 6c 6c 69 61 6d 
27...136 more bytes />
28*/

with schema:

1import BVON, { UOID } from '@neumatter/bvon'
2
3const user = {
4  id: new UOID('2LD32T9NBPMF3YDQYLVANMG22A2J'),
5  name: {
6    first: 'Mike',
7    last: 'Williamson'
8  },
9  createdAt: new Date('2023-03-02T06:00:00.000Z'),
10  modifiedAt: new Date('2023-03-13T06:00:00.000Z'),
11  settings: {
12    theme: 'dark',
13    fontSize: 15,
14    formOfContact: 'text'
15  },
16  phone: '8889991234'
17}
18
19const userSchema = new BVON.Schema({
20  id: 'UOID',
21  name: {
22    first: 'String',
23    last: 'String'
24  },
25  createdAt: 'Date',
26  modifiedAt: 'Date',
27  settings: {
28    theme: 'String',
29    fontSize: 'Number',
30    formOfContact: 'String'
31  },
32  phone: 'String'
33})
34
35console.log(BVON.serialize(user, userSchema))
36
37/*
38prints: <ByteView(143) 09 08 06 0e 08 01 10 08 1c 
3932 4c 44 33 32 54 39 4e 42 50 4d 46 33 59 44 51 59 
404c 56 41 4e 4d 47 32 32 41 32 4a 0e 08 02 09 08 02 
410e 08 03 06 08 04 4d 69 6b 65 0e 08 04 06 08 0a 57 
4269 6c 6c 69 61 6d 73 6f 6e 0e 08 05 08 00 ef e7 a0 
4386 01 00 00 ...63 more bytes />
44*/

(method) BVON.deserialize:

Args [data: any, schema?: BVON.Schema]

If the data was serialized using a schema, it must also be deserialized with a schema.

Returns any

1import BVON from '@neumatter/bvon'
2
3console.log(BVON.deserialize(serializedUser))
4
5/*
6{
7  id: UOID('2LD32T9NBPMF3YDQYLVANMG22A2J'),
8  name: { first: 'Mike', last: 'Williamson' },
9  createdAt: 2023-03-02T06:00:00.000Z,
10  modifiedAt: 2023-03-13T06:00:00.000Z,
11  settings: { theme: 'dark', fontSize: 15, formOfContact: 'text' },
12  phone: '8889991234'
13}
14*/