binary-extract

Extract values from a binary json blob

Usage no npm install needed!

<script type="module">
  import binaryExtract from 'https://cdn.skypack.dev/binary-extract';
</script>

README

binary-extract

Extract one or more values from a buffer of json without parsing the whole thing.

build status

Example

var extract = require('binary-extract');

var buf = new Buffer(JSON.stringify({
  foo: 'bar',
  bar: 'baz',
  nested: {
    bar: 'nope'  
  } 
}));

var value = extract(buf, 'bar');
// => 'baz'

var values = extract(buf, ['foo', 'nested'])
// => ["bar", {"bar":"nope"}]

Perf

With the object from bench.js, extract() is ~2-4x faster than JSON.parse(buf.toString()). It is also way more memory efficient as the blob stays out of the V8 heap.

The big perf gain comes mainly from not parsing everything and not converting the buffer to a string.

Installation

$ npm install binary-extract

API

extract(buf, keys)

Extract the value of keys in the json buf.

The value can be any valid JSON structure.

If keys is a String, returns a value. If keys is an Array of keys, returns an array of values.

License

MIT