Package Exports

flatbuffers

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (flatbuffers) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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 flatbuffers
```

Use the library:

var flatbuffers = require('flatbuffers');
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 }