flatbuffers-addon

Generate flatbuffers directly from node.

Generate binary

1const flatc = require("flatbuffers-addon");
2const buffer = flatc.binary(options);

options.schema

type: String|Buffer

if schema is a String and schema_contents is null or undefined, schema will be treated as schema_contents. otherwise, it will be treated as the schema file path.

options.schema_contents

type: String|Buffer

The schema contents. If the schema_contents is a schema binary, the schema file path must end with .bfbs.

options.schema_binary

type: bool default: false

Serialize schemas instead of JSON

options.json

type: String|Buffer|Object

if json is a String and json_contents is null or undefined, json will be treated as json_contents. if json is a Buffer or an Object, json will be treated as json_contents. otherwise json must be a String and will be treated as the path to the JSON.

options.json_contents

type: String|Buffer|Object

The JSON to serialize

options.include_directories

type: [String]

Include directories for schemas

options.conform

type: String|Buffer

Specify a schema the following schema should be an evolution of.

if conform is a String and conform_contents is null or undefined, conform will be treated as conform_contents.

options.conform_contents

type: String|Buffer

Conform schema contents.

options.conform_include_directories

type: [String]

Include directories for conform schemas

options.strict_json

NOT TESTED

type: bool default: false

field names must be / will be quoted, no trailing commas in tables/vectors.

options.ignore_null_scalar

type: bool default: false

Allow scalar fields to be null

options.allow_non_utf8

NOT TESTED

type: bool default: false

Pass non-UTF-8 input through parser

options.skip_unexpected_fields_in_json

type: bool default: false

Allow fields in JSON that are not defined in the schema. These fields will be discared when generating binaries.

options.size_prefixed

NOT TESTED

type: bool default: false

Input binaries are size prefixed buffers.

options.proto_mode

NOT TESTED

type: bool default: false

Input is a .proto, translate to .fbs.

options.proto_oneof_union

NOT TESTED

type: bool default: false

Translate .proto oneofs to flatbuffer unions.

options.binary_schema_comments

NOT TESTED

type: bool default: false

Add doc comments to the binary schema files.

options.binary_schema_builtins

NOT TESTED

type: bool default: false

Add builtin attributes to the binary schema files.

options.force_defaults

type: bool default: false

If false, don't serialize values equal to the default, therefore reducing size of the binary output.

Generate js

1const flatc = require("flatbuffers-addon");
2const code = flatc.js(options);

options.schema

type: String|Buffer

if schema is a String and schema_contents is null or undefined, schema will be treated as schema_contents. otherwise, it will be treated as the schema file path.

options.schema_contents

type: String|Buffer

The schema contents. If the schema_contents is a schema binary, the schema file path must end with .bfbs.

options.include_directories

type: [String]

Include directories for schemas

options.conform

type: String|Buffer

Specify a schema the following schema should be an evolution of.

if conform is a String and conform_contents is null or undefined, conform will be treated as conform_contents.

options.conform_contents

type: String|Buffer

Conform schema contents.

options.conform_include_directories

type: [String]

Include directories for conform schemas

options.type

NOT TESTED

type: String

ts to generate TypeScript code.

options.allow_non_utf8

NOT TESTED

type: bool default: false

Pass non-UTF-8 input through parser

options.mutable_buffer

type: bool default: false

Generate accessors that can mutate buffers in-place.

options.generate_all

NOT TESTED

type: bool default: false

Generate not just code for the current schema files, but for all files it includes as well. If the language uses a single file for output (by default the case for C++ and JS), all code will end up in this one file.

options.skip_js_exports

type: bool default: false

Removes Node.js style export lines in JS.

options.use_goog_js_export_format

NOT TESTED

type: bool default: false

Uses goog.exports* for closure compiler exporting in JS.

options.use_ES6_js_export_format

NOT TESTED

type: bool default: false

Uses ECMAScript 6 export style lines in JS.

options.keep_include_path

NOT TESTED

type: bool default: false

Keep original prefix of schema include statement.

options.skip_flatbuffers_import

NOT TESTED

type: bool default: false

Don't include flatbuffers import statement for TypeScript.

options.reexport_ts_modules

NOT TESTED

type: bool default: true

re-export imported dependencies for TypeScript

options.js_ts_short_names

NOT TESTED

type: bool default: true

Use short function names for JS and TypeScript.

Examples

1const { flatbuffers } = require("flatbuffers");
2const flatc = require("flatbuffers-addon");
3
4const schema = `
5    namespace some.nested.namespace;
6
7    file_extension "dat";
8
9    table Book {
10        id:string (id: 0);
11        title:string (id: 1);
12        authors:[string] (id: 2);
13        release:ulong (id: 3);
14        genres: [ulong] (id: 4);
15    }
16
17    table Library {
18        name:string (id: 0);
19        books: [Book] (id: 1);
20    }
21
22    root_type Library;
23`;
24
25const js = flatc.js({
26    schema
27});
28
29const library = {
30    name: "BookShop 0",
31    books: [{
32        id: "book-0",
33        title: "Book 0",
34        authors: ["Author 0"]
35    }]
36};
37
38
39const buffer = flatc.binary({
40    schema,
41    json: library
42});
43
44const deserialized = ((code, binary) => {
45    // Evalute generated js code
46    const sandbox = {};
47    (new Function(code)).call(sandbox);
48
49    // @see https://google.github.io/flatbuffers/flatbuffers_guide_use_javascript.html
50    const bytes = new Uint8Array(binary);
51    const buf = new flatbuffers.ByteBuffer(bytes);
52
53    // Deserialized flatbuffers binary data
54    const Library = sandbox.some.nested.namespace.Library;
55    return Library.getRootAsLibrary(buf);
56
57})(js, buffer);
58
59console.log(deserialized.name() === "BookShop 0");
60console.log(deserialized.books(0).title() === "Book 0");
61