-
Notifications
You must be signed in to change notification settings - Fork 0
/
package.json
55 lines (55 loc) · 5.94 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
"name": "JSONStream",
"version": "1.0.4",
"description": "rawStream.pipe(JSONStream.parse()).pipe(streamOfObjects)",
"homepage": "http://github.com/dominictarr/JSONStream",
"repository": {
"type": "git",
"url": "git://github.com/dominictarr/JSONStream.git"
},
"license": "(MIT OR Apache-2.0)",
"keywords": [
"json",
"stream",
"streaming",
"parser",
"async",
"parsing"
],
"dependencies": {
"jsonparse": "~1.0.0",
"through": ">=2.2.7 <3"
},
"devDependencies": {
"it-is": "~1",
"assertions": "~2.2.2",
"render": "~0.1.1",
"trees": "~0.0.3",
"event-stream": "~0.7.0",
"tape": "~2.12.3"
},
"bin": {
"JSONStream": "./index.js"
},
"author": {
"name": "Dominic Tarr",
"email": "dominic.tarr@gmail.com",
"url": "http://bit.ly/dominictarr"
},
"scripts": {
"test": "set -e; for t in test/*.js; do echo '***' $t '***'; node $t; done"
},
"optionalDependencies": {},
"engines": {
"node": "*"
},
"readme": "# JSONStream\n\nstreaming JSON.parse and stringify\n\n![](https://secure.travis-ci.org/dominictarr/JSONStream.png?branch=master)\n\n## example\n\n``` js\n\nvar request = require('request')\n , JSONStream = require('JSONStream')\n , es = require('event-stream')\n\nrequest({url: 'http://isaacs.couchone.com/registry/_all_docs'})\n .pipe(JSONStream.parse('rows.*'))\n .pipe(es.mapSync(function (data) {\n console.error(data)\n return data\n }))\n```\n\n## JSONStream.parse(path)\n\nparse stream of values that match a path\n\n``` js\n JSONStream.parse('rows.*.doc')\n```\n\nThe `..` operator is the recursive descent operator from [JSONPath](http://goessner.net/articles/JsonPath/), which will match a child at any depth (see examples below).\n\nIf your keys have keys that include `.` or `*` etc, use an array instead.\n`['row', true, /^doc/]`.\n\nIf you use an array, `RegExp`s, booleans, and/or functions. The `..` operator is also available in array representation, using `{recurse: true}`.\nany object that matches the path will be emitted as 'data' (and `pipe`d down stream)\n\nIf `path` is empty or null, no 'data' events are emitted.\n\n### Examples\n\nquery a couchdb view:\n\n``` bash\ncurl -sS localhost:5984/tests/_all_docs&include_docs=true\n```\nyou will get something like this:\n\n``` js\n{\"total_rows\":129,\"offset\":0,\"rows\":[\n { \"id\":\"change1_0.6995461115147918\"\n , \"key\":\"change1_0.6995461115147918\"\n , \"value\":{\"rev\":\"1-e240bae28c7bb3667f02760f6398d508\"}\n , \"doc\":{\n \"_id\": \"change1_0.6995461115147918\"\n , \"_rev\": \"1-e240bae28c7bb3667f02760f6398d508\",\"hello\":1}\n },\n { \"id\":\"change2_0.6995461115147918\"\n , \"key\":\"change2_0.6995461115147918\"\n , \"value\":{\"rev\":\"1-13677d36b98c0c075145bb8975105153\"}\n , \"doc\":{\n \"_id\":\"change2_0.6995461115147918\"\n , \"_rev\":\"1-13677d36b98c0c075145bb8975105153\"\n , \"hello\":2\n }\n },\n]}\n\n```\n\nwe are probably most interested in the `rows.*.doc`\n\ncreate a `Stream` that parses the documents from the feed like this:\n\n``` js\nvar stream = JSONStream.parse(['rows', true, 'doc']) //rows, ANYTHING, doc\n\nstream.on('data', function(data) {\n console.log('received:', data);\n});\n```\nawesome!\n\n### recursive patterns (..)\n\n`JSONStream.parse('docs..value')` \n(or `JSONStream.parse(['docs', {recurse: true}, 'value'])` using an array)\nwill emit every `value` object that is a child, grand-child, etc. of the \n`docs` object. In this example, it will match exactly 5 times at various depth\nlevels, emitting 0, 1, 2, 3 and 4 as results.\n\n```js\n{\n \"total\": 5,\n \"docs\": [\n {\n \"key\": {\n \"value\": 0,\n \"some\": \"property\"\n }\n },\n {\"value\": 1},\n {\"value\": 2},\n {\"blbl\": [{}, {\"a\":0, \"b\":1, \"value\":3}, 10]},\n {\"value\": 4}\n ]\n}\n```\n\n## JSONStream.parse(pattern, map)\n\nprovide a function that can be used to map or filter\nthe json output. `map` is passed the value at that node of the pattern,\nif `map` return non-nullish (anything but `null` or `undefined`)\nthat value will be emitted in the stream. If it returns a nullish value,\nnothing will be emitted.\n\n## JSONStream.stringify(open, sep, close)\n\nCreate a writable stream.\n\nyou may pass in custom `open`, `close`, and `seperator` strings.\nBut, by default, `JSONStream.stringify()` will create an array,\n(with default options `open='[\\n', sep='\\n,\\n', close='\\n]\\n'`)\n\nIf you call `JSONStream.stringify(false)`\nthe elements will only be seperated by a newline.\n\nIf you only write one item this will be valid JSON.\n\nIf you write many items,\nyou can use a `RegExp` to split it into valid chunks.\n\n## JSONStream.stringifyObject(open, sep, close)\n\nVery much like `JSONStream.stringify`,\nbut creates a writable stream for objects instead of arrays.\n\nAccordingly, `open='{\\n', sep='\\n,\\n', close='\\n}\\n'`.\n\nWhen you `.write()` to the stream you must supply an array with `[ key, data ]`\nas the first argument.\n\n## unix tool\n\nquery npm to see all the modules that browserify has ever depended on.\n\n``` bash\ncurl https://registry.npmjs.org/browserify | JSONStream 'versions.*.dependencies'\n```\n\n## numbers\n\nThere are occasional problems parsing and unparsing very precise numbers.\n\nI have opened an issue here:\n\nhttps://github.com/creationix/jsonparse/issues/2\n\n+1\n\n## Acknowlegements\n\nthis module depends on https://github.com/creationix/jsonparse\nby Tim Caswell\nand also thanks to Florent Jaby for teaching me about parsing with:\nhttps://github.com/Floby/node-json-streams\n\n## license\n\nDual-licensed under the MIT License or the Apache License, version 2.0\n",
"readmeFilename": "readme.markdown",
"bugs": {
"url": "https://github.com/dominictarr/JSONStream/issues"
},
"_id": "JSONStream@1.0.4",
"_shasum": "aa86d6a89c8e77f206cd542581b563e7eee32459",
"_from": "JSONStream@>=1.0.3 <2.0.0",
"_resolved": "https://registry.npmjs.org/JSONStream/-/JSONStream-1.0.4.tgz"
}