Package Exports

binary-types
binary-types/read.es5.js
binary-types/read.js

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

Readme

binary-types

helpers for binary-parser

Installation

npm install binary-types

Types

u8
u16le
u16be
u32le
u32be
f32le
f32be
f64le
f64be

Examples

'use strict'
var binary = require('binary-types')
  , read = binary.read
  , write = binary.write

exports.parse = require('binary-parser')(function* parser() {
  var value = yield* read.u8()
  return value
})

exports.bufferify = function(str) {
  var buf = Buffer(str.length)
  if (buf.length > 0xFF) throw new Error('too long')
  return Buffer.concat(write.u8(buf.length), buf)
}

API

var binary = require('binary-types')
  , read = binary.read
  , write = binary.write

`yield* read[type]()`

returns the decoded value.

`write[type](value)`

returns a buffer with the encoded value.

endianness shortcuts

to avoid repeating the endianness over and over:

> read.be.u16 === read.u16be
true
> read.le.u16 === read.u16le
true
> binary.le.read === read.le
true
> binary.be.write === write.be
true