63 lines
9.4 KiB
JSON
63 lines
9.4 KiB
JSON
|
{
|
||
|
|
"name": "event-stream",
|
||
|
|
"version": "3.0.16",
|
||
|
|
"description": "construct pipes of streams of events",
|
||
|
|
"homepage": "http://github.com/dominictarr/event-stream",
|
||
|
|
"repository": {
|
||
|
|
"type": "git",
|
||
|
|
"url": "git://github.com/dominictarr/event-stream.git"
|
||
|
|
},
|
||
|
|
"dependencies": {
|
||
|
|
"through": "~2.3.1",
|
||
|
|
"duplexer": "~0.0.2",
|
||
|
|
"from": "~0",
|
||
|
|
"map-stream": "0.0.2",
|
||
|
|
"pause-stream": "0.0.10",
|
||
|
|
"split": "0.2",
|
||
|
|
"stream-combiner": "0.0.0"
|
||
|
|
},
|
||
|
|
"devDependencies": {
|
||
|
|
"asynct": "*",
|
||
|
|
"it-is": "1",
|
||
|
|
"ubelt": "~2.9",
|
||
|
|
"stream-spec": "~0.2",
|
||
|
|
"tape": "~0.1.5"
|
||
|
|
},
|
||
|
|
"scripts": {
|
||
|
|
"test": "asynct test/",
|
||
|
|
"test_tap": "set -e; for t in test/*.js; do node $t; done"
|
||
|
|
},
|
||
|
|
"testling": {
|
||
|
|
"files": "test/*.js",
|
||
|
|
"browsers": {
|
||
|
|
"ie": [
|
||
|
|
8,
|
||
|
|
9
|
||
|
|
],
|
||
|
|
"firefox": [
|
||
|
|
13
|
||
|
|
],
|
||
|
|
"chrome": [
|
||
|
|
20
|
||
|
|
],
|
||
|
|
"safari": [
|
||
|
|
5.1
|
||
|
|
],
|
||
|
|
"opera": [
|
||
|
|
12
|
||
|
|
]
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"author": {
|
||
|
|
"name": "Dominic Tarr",
|
||
|
|
"email": "dominic.tarr@gmail.com",
|
||
|
|
"url": "http://bit.ly/dominictarr"
|
||
|
|
},
|
||
|
|
"readme": "# EventStream\n\n<img src=https://secure.travis-ci.org/dominictarr/event-stream.png?branch=master>\n\n[]\n(http://ci.testling.com/dominictarr/event-stream)\n\n[Streams](http://nodejs.org/api/strems.html \"Stream\") are node's best and most misunderstood idea, and \n_<em>EventStream</em>_ is a toolkit to make creating and working with streams <em>easy</em>. \n\nNormally, streams are only used of IO, \nbut in event stream we send all kinds of objects down the pipe. \nIf your application's <em>input</em> and <em>output</em> are streams, \nshouldn't the <em>throughput</em> be a stream too? \n\nThe *EventStream* functions resemble the array functions, \nbecause Streams are like Arrays, but laid out in time, rather than in memory. \n\n<em>All the `event-stream` functions return instances of `Stream`</em>.\n\n`event-stream` creates \n[0.8 streams](https://github.com/joyent/node/blob/v0.8/doc/api/stream.markdown)\n, which are compatible with [0.10 streams](http://nodejs.org/api/stream.html \"Stream\")\n\n>NOTE: I shall use the term <em>\"through stream\"</em> to refer to a stream that is writable <em>and</em> readable. \n\n###[simple example](https://github.com/dominictarr/event-stream/blob/master/examples/pretty.js):\n\n``` js\n\n//pretty.js\n\nif(!module.parent) {\n var es = require('event-stream')\n es.pipeline( //connect streams together with `pipe`\n process.openStdin(), //open stdin\n es.split(), //split stream to break on newlines\n es.map(function (data, callback) {//turn this async function into a stream\n callback(null\n , inspect(JSON.parse(data))) //render it nicely\n }),\n process.stdout // pipe it to stdout !\n )\n }\n```\nrun it ...\n\n``` bash \ncurl -sS registry.npmjs.org/event-stream | node pretty.js\n```\n \n[node Stream documentation](http://nodejs.org/api/stream.html)\n\n## through (write?, end?)\n\nReemits data synchronously. Easy way to create syncronous through streams.\nPass in an optional `write` and `end` methods. They will be called in the \ncontext of the stream. Use `this.pause()` and `this.resume()` to manage flow.\nCheck `this.paused` to see current flow state. (write always returns `!this.paused`)\n\nthis function is the basis for most of the syncronous streams in `event-stream`.\n\n``` js\n\nes.through(function write(data) {\n this.emit('data', data)\n //this.pause() \n },\n function end () { //optional\n this.emit('end')\n })\n\n```\n\n##map (asyncFunction)\n\nCreate a through stream from an asyncronous function. \n\n``` js\nvar es = require('event-stream')\n\nes.map(function (data, callback) {\n //transform data\n // ...\n callback(null, data)\n})\n\n```\n\nEach map MUST call the callback. It may callback with data, with an error or with no arguments, \n\n * `callback()` drop this data. \n this makes the map work like `filter`, \n note:`callback(null,null)` is not the same, and will emit `null`\n\n * `callback(null, newData)` turn data into newData\n \n * `callback(error)` emit an error for this item.\n\n>Note: if a callback is not called, `map` will think that it is still being processed, \n>every call must be answered or the stream will not know when to end. \n>\n>Also, if the callback is called more than once, every call but the first will be ignored.\n\n## mapSync (syncFunction)\n\nSame as `map`, but the callback is called synchronously. Based on `es.through`\n\n## split (matcher)\n\nBreak up a stream and reassemble it so that each line is a chunk. matcher may be a `String`, or a `RegExp` \n\nExample, read every line in a file ...\n\n``` js\n es.pipeline(\n fs.createReadStream(file, {flags: 'r'}),\n es.split(),\n es.map(function (line, cb) {\n //do something with the line \n cb(null, line)\n })\n )\n\n```\n\n`split` takes the same arguments as `string.split` except it defaults to '\\n' instead of ',', and the optional `limit` pare
|
||
|
|
"_id": "event-stream@3.0.16",
|
||
|
|
"dist": {
|
||
|
|
"shasum": "0b040584bf4f31ca2d250d6a2ee285fea3e8e358"
|
||
|
|
},
|
||
|
|
"_from": "event-stream@~3.0.14"
|
||
|
|
}
|