npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

calippo

v0.0.2

Published

binary stream parser

Downloads

4

Readme

Calippo

Binary stream parser for node

Callipo is a more modern implementation of an existing binary stream parser for node called node-strtok. The biggest difference is that with node 0.10 we can leverage the more modern Streams2 API which provides us with out of the box methods for consuming and transforming streams of binary data.

Calippo is not intended to be a high level DSL for parsing binary streams ala node-binary, this sits lower in the stack, capable of implementing more novel abstractions on top of callipo.

Installation

Install via npm:

npm install calippo

Usage

Pulls out the data in an int32 prefixed message stream: [int32][data][int32][data]...

var Calippo = require('calippo')

var pos

var parser = Calippo(function (value) {
  if (value === undefined) {
    pos = 0
    return this.readUInt32LE
  }
  if (pos === 0) {
    pos = 1
    return this.Buffer(value)
  }
  if (pos === 1) {
    this.push(value)
    pos = 0
    return this.readUInt32LE
  }
})

parser.on('readable', function () {
  while (console.log(parser.read())) {}
})

somestream.pipe(parser)

API

Calippo(callback, options)

callback takes a single argument, the value just read from the stream, and is expected to return the type of value to read next, e.g. this.Buffer(len). It is this callback that ultimately implements the application protocol, you are expected to manage state yourself.

options is an object passed down into the node Transform api, pass {objectMode: true} if you want to output non binary data with this.push()

All expected values are returned from the callback, and and the types of values available are all attached to the this scope within the callback:

this.Buffer(len)

this.String(len, encoding)

this.Skip(len) - skip (len) bytes, calls callback with null

Calippo also implements all the standard node buffer readXXX methods for parsing numbers, see http://nodejs.org/api/buffer.html

this.readUInt32LE

this.readUInt8

...

We also implement one special type, DEFER and one method defer. These are used together for when you don't yet know what type of value you want to read next, perhaps you need to wait on some network event:

var parser = Calippo(function (value) {
  if (value === undefined) {
    var self = this
    makeSomeWebRequest(function () {
      self.defer(self.Buffer(2))
    })
    return this.DEFER
  }
})

this.defer takes one argument, the next expected type, you must return this.DEFER before your callback is called.

Licence

MIT