0.1.0 • Published 7 years ago

endeo-std v0.1.0

Weekly downloads
3
License
MIT
Repository
github
Last release
7 years ago

endeo-std

Dependency Status npm version

Aggregates standard endeo implementations for easy install.

See packages:

  1. endeo
  2. enbyte
  3. debyte
  4. unstring
  5. @endeo/decoder
  6. @endeo/bytes
  7. @endeo/types
  8. @endeo/input
  9. @endeo/output

Install

npm install --save endeo-std

Usage

See endeo for usage. This package depends on all the standard component implementations so they can be installed conveniently via npm install -S endeo-std.

// the super short version:

// get builder
var buildEndeo = require('endeo')

// build it
var endeo = buildEndeo()

// encode object/array/string
var result = endeo.encode({ some: 'object' })
// result has `error` or `buffer`
var buffer = result.buffer

// decode buffer back into an object
var object = endeo.decode(buffer, 0)


// streaming version...
var encoder = endeo.encoder()
encoder.pipe(someTargetStream)
encoder.write({ some: 'object' })
encoder.write([ 'some', 'array'])

var decoder = endeo.decoder()
decoder.pipe(someTargetStream)
decoder.on('data', function(thing){
  // thing = object/array
})

MIT License