Package Exports

protodef

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 (protodef) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ProtoDef

This is a node.js module to simplify defining, reading and writing binary blobs, whether they be internet protocols or files.

Installing

This project is not on NPM yet, since it is far from being usable. If you still want to use it,

npm i --save roblabla/protodef

API Stability

This project is going to undergo lots of api changes before 1.0, so if you depend on this project, you should specify the hash you build against

Usage

var protodef = require('protodef');
var proto = protodef.create();
proto.addType("");

What's done

Currently, only the deserialization engine is done and used. Serialization is far from done.

TODO

Write tests for every datatypes, and the different *Field behaviors.
Rethink datatype function signature
Datatypes should include name when creating them, instead of being provided by the user, to ease datatype dependencies.
Write the serialization stream.
Probably more...