README.md

Avsc

Pure JavaScript implementation of the Avro specification.

Features

• Blazingly fast and compact serialization! Typically faster than JSON with much smaller encodings.
• All the Avro goodness, including schema evolution and remote procedure calls.
• Support for serializing arbitrary JavaScript objects.
• Unopinionated 64-bit integer compatibility.

Installation

$ npm install avsc

avsc is compatible with all versions of node.js since 0.11 and major browsers via browserify (see the full compatibility table here). For convenience, you can also find compiled distributions with the releases (but please host your own copy).

Documentation

• Home
• API
• Quickstart
• Advanced usage
• Benchmarks

Examples

Inside a node.js module, or using browserify:

var avro = require('avsc');

• Encode and decode values:

  var type = avro.parse({
    name: 'Pet',
    type: 'record',
    fields: [
      {name: 'kind', type: {name: 'Kind', type: 'enum', symbols: ['CAT', 'DOG']}},
      {name: 'name', type: 'string'}
    ]
  });
  var buf = type.toBuffer({kind: 'CAT', name: 'Albert'}); // Encoded buffer.
  var val = type.fromBuffer(buf); // {kind: 'CAT', name: 'Albert'}

• Get a readable stream of decoded values from an Avro container file:

  avro.createFileDecoder('./values.avro')
    .on('metadata', function (type) { /* `type` is the writer's type. */ })
    .on('data', function (val) { /* Do something with the decoded value. */ });

• Implement a TCP server for an IDL-defined protocol:

  avro.assemble('./Ping.avdl', function (err, attrs) {
    var protocol = avro.parse(attrs);
    protocol.on('ping', function (req, ee, cb) { cb(null, 'pong'); });
    require('net').createServer()
      .on('connection', function (con) { protocol.createListener(con); })
      .listen(8000);
  });