node-fbs
v1.0.0
Published
An implementation of FlatBuffers in pure JavaScript forked from https://github.com/evanw/node-flatbuffers
Downloads
2
Readme
FlatBuffers in JavaScript
This is an implementation of FlatBuffers in pure JavaScript. Unlike the official compiler, this implementation generates JavaScript code to convert between JavaScript objects and FlatBuffers at run time using the JIT. It currently requires binary schemas compiled with the flatc
compiler, which is written in C++ and has to be built (see the build instructions).
Example Usage
Create a schema called
example.fbs
:table Example { x: float; y: float; } root_type Example;
Generate the binary schema called
example.bfbs
:flatc --binary --schema example.fbs
Install this library:
npm install node-fbs
Use the library:
var flatbuffers = require('node-fbs'); var fs = require('fs'); var example = flatbuffers.compileSchema(fs.readFileSync('example.bfbs')); var generated = example.generate({ x: 1, y: 2 }); var parsed = example.parse(generated); console.log('generated:', Array.from(generated)); console.log('parsed:', parsed);
Running that code should print this:
generated: [ 12, 0, 0, 0, 8, 0, 12, 0, 8, 0, 4, 0, 8, 0, 0, 0, 0, 0, 0, 64, 0, 0, 128, 63 ]
parsed: { x: 1, y: 2 }