The .. operator is the recursive descent operator from JSONPath, which will match a child at any depth (see examples below).
If your keys have keys that include . or * etc, use an array instead.
['row', true, /^doc/].
If you use an array, RegExps, booleans, and/or functions. The .. operator is also available in array representation, using {recurse: true}.
any object that matches the path will be emitted as 'data' (and piped down stream)
If path is empty or null, no 'data' events are emitted.
If you want to have keys emitted, you can prefix your * operator with $: obj.$* - in this case the data passed to the stream is an object with a key holding the key and a value property holding the data.
create a Stream that parses the documents from the feed like this:
var stream = JSONStream.parse(['rows', true, 'doc']) //rows, ANYTHING, docstream.on('data', function(data) { console.log('received:', data);});//emits anything from _before_ the first matchstream.on('header', function (data) { console.log('header:', data) // => {"total_rows":129,"offset":0}})
awesome!
In case you wanted the contents the doc emitted:
var stream = JSONStream.parse(['rows', true, 'doc', {emitKey: true}]) //rows, ANYTHING, doc, items in docs with keysstream.on('data', function(data) { console.log('key:', data.key); console.log('value:', data.value);});
You can also emit the path:
var stream = JSONStream.parse(['rows', true, 'doc', {emitPath: true}]) //rows, ANYTHING, doc, items in docs with keysstream.on('data', function(data) { console.log('path:', data.path); console.log('value:', data.value);});
recursive patterns (..)
JSONStream.parse('docs..value')
(or JSONStream.parse(['docs', {recurse: true}, 'value']) using an array)
will emit every value object that is a child, grand-child, etc. of the
docs object. In this example, it will match exactly 5 times at various depth
levels, emitting 0, 1, 2, 3 and 4 as results.
provide a function that can be used to map or filter
the json output. map is passed the value at that node of the pattern,
if map return non-nullish (anything but null or undefined)
that value will be emitted in the stream. If it returns a nullish value,
nothing will be emitted.
JSONStream also emits 'header' and 'footer' events,
the 'header' event contains anything in the output that was before
the first match, and the 'footer', is anything after the last match.
JSONStream.stringify(open, sep, close)
Create a writable stream.
you may pass in custom open, close, and seperator strings.
But, by default, JSONStream.stringify() will create an array,
(with default options open='[\n', sep='\n,\n', close='\n]\n')
If you call JSONStream.stringify(false)
the elements will only be seperated by a newline.
If you only write one item this will be valid JSON.
If you write many items,
you can use a RegExp to split it into valid chunks.
JSONStream.stringifyObject(open, sep, close)
Very much like JSONStream.stringify,
but creates a writable stream for objects instead of arrays.