Broken Usage Example in README

[bsingr]

Hey folks,

the current README gives the following example:

var buffer = binarize.pack(function(object) {  
   ...  
});

However, the pack function expects an object as the first argument and the callback function as the second argument. Also it won’t return a buffer, but invoke the callback function with a DataView.

For me, the following works:

var object;
object = {
  name: 'Eiji Kitamura',
  array: [1, 2, 3],
  object: {
    name: 'Eiji Kitamura',
    hello: 'こんにちは'
  }
};
binarize.pack(object, function(dataView) {
  console.log('packed!', dataView);
  binarize.unpack(dataView.buffer, function(unpacked) {
    console.log('unpacked', unpacked);
  });
});

What is the README describing? Is it just outdated?

Regards,
—dpree

[agektmr]

You are absolutely correct. AudioStreamer has a real world example. I will fix the documentation.
Thanks for reporting!