lifion-aws-event-stream

lifion-aws-event-stream

Node.js parser for binary streams under the application/vnd.amazon.eventstream content-type.

Getting Started

To install the module:

npm install lifion-aws-event-stream --save

The module exports a parse function and a Parser stream. To use the parse function:

const { parse } = require('lifion-aws-event-stream');

const buffer = Buffer.from('000000100000000005c248eb7d98c8ff', 'hex');
console.log(parse(buffer)); // { headers: {}, payload: '' }

To use the Parser stream:

const { Parser } = require('lifion-aws-event-stream');

const parser = new Parser();
parser.on('data', console.log); // { headers: {}, payload: '' }

const buffer = Buffer.from('000000100000000005c248eb7d98c8ff', 'hex');
parser.write(buffer);

Pipe an HTTP response to parse the messages as they arrive:

const got = require('got');
const { Parser } = require('lifion-aws-event-stream');
const { pipeline } = require('stream');

pipeline([
  got('/', …),
  new Parser(),
  new Writable({
    objectMode: true,
    write(data, encoding, callback) {
      console.log(data);
      callback();
    }
  }),
]);

This project's implementation is based on:

• https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-eventstream
• https://github.com/awslabs/aws-c-event-stream

API Reference

• lifion-aws-event-stream
  • static
    • .parse(buffer) ⇒ object
  • inner
    • ~Parser ⇐ Transform

eventStream.parse(buffer) ⇒ object

Parses the specified buffer with vnd.amazon.eventstream data into an object.

Kind: static method of lifion-aws-event-stream
Returns: object - The parsed vnd.amazon.eventstream object.
Throws:

• Error Whenever:
  • The specified buffer has less than 16 bytes. The minimum vnd.amazon.eventstream message should have 4 bytes for the total length of the package, 4 bytes for the length of the headers section, 4 bytes for the checksum of the prelude, and finally 4 more bytes for the checksum of the entire message.
  • The total length as specified in the message doesn't matches the bufffer length.
  • The checksum of the prelude doesn't matches the calculated checksum.
  • The checksum of the message doesn't matches the calculated checksum.
  • The header value type is unknown.

Param	Type	Description
buffer	Buffer	The buffer to parse.

lifion-aws-event-stream~Parser ⇐ Transform

A transform stream that calls parse with the binary data written to it. Can be used to pipe a response stream from an AWS service HTTP request. The stream will emit errors thrown during parse calls.

Kind: inner class of lifion-aws-event-stream
Extends: Transform

License

MIT

Changelog

v1.0.6 (2019-10-18)

• #105: Update dependency eslint to ^6.4.0
• #106: Update dependency codecov to ^3.6.1
• #107: Update dependency lint-staged to ^9.3.0
• #104: Update dependency auto-changelog to ^1.16.1
• #100: Update dependency eslint to ^6.3.0
• #101: Update dependency jsdoc-to-markdown to ^5.0.1
• #102: Update dependency auto-changelog to ^1.16.0
• #103: Update dependency husky to ^3.0.5
• #99: Update dependency lint-staged to ^9.2.5
• #92: Update dependency husky to ^3.0.2
• #91: Update dependency lint-staged to ^9.2.1
• #90: Update dependency husky to ^3.0.1
• a414c06: Adopt core commons 2.3.3
• 69c18a1: Recreate the package-lock.json file
• e6f25d4: Upgrade dependencies
• 74a2e5e: Recreate lock file
• 007a53f: Create CODE_OF_CONDUCT.md
• a9cad41: Recreate lock file
• 4cc21ee: Adopt core commons 2.3.3