Nuanced Pumpkin Mavens

    node-fbs

    1.0.0 • Public • Published

    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

    1. Create a schema called example.fbs:

      table Example {
        x: float;
        y: float;
      }
      
      root_type Example;
      
    2. Generate the binary schema called example.bfbs:

      flatc --binary --schema example.fbs
      
    3. Install this library:

      npm install node-fbs
      
    4. 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 }
    

    Keywords

    none

    Install

    npm i node-fbs

    DownloadsWeekly Downloads

    3

    Version

    1.0.0

    License

    Apache License, Version 2.0

    Unpacked Size

    74.1 kB

    Total Files

    6

    Last publish

    Collaborators

    • wandergis