sink-transform
v2.0.0
Published
Wrapper for concat-stream to make a transform
Downloads
9,480
Readme
sink-transform
A wrapper for concat-stream to make a transform to process the concated result.
Examples
Concat objects
example/reverse.js:
var sink = require('sink-transform')
var JSONStream = require('JSONStream')
var stream = sink.obj(function (rows, done) {
for (var i = rows.length - 1; i >= 0; --i) {
this.push(rows[i])
}
done()
})
stream.pipe(JSONStream.stringify()).pipe(process.stdout)
stream.write({ x:1 })
stream.write({ y:2 })
stream.write({ z:3 })
stream.end()
output:
⌘ node example/reverse.js
[
{"z":3}
,
{"y":2}
,
{"x":1}
]
Concat strings
example/concat.js:
var sink = require('sink-transform')
var fs = require('fs')
fs.createReadStream(__dirname + '/files/a.js')
.pipe(sink.str(function (body, done) {
console.log(body)
done()
}))
a.js:
console.log('a')
output:
⌘ node example/concat.js
console.log('a')
Usage
var sink = require('sink-transform')
var stream = sink(opts, trs)
stream = sink(opts={}, transformFn)
opts
Type: Object
Directly passsed to concat-stream as the first argument.
transformFn
Type: Function
Signature: (concated, done) => {}
Receives the concated result of concat-stream, and a callback to mark the end of the transform operation.
stream = sink.obj(transformFn)
Same with sink({ encoding: 'object' }, transformFn)
stream = sink.str(transformFn)
Same with sink({ encoding: 'string' }, transformFn)