@zitterorg/reiciendis-ex-fuga v4.3.30
@zitterorg/reiciendis-ex-fuga
This is a super thin wrapper around through2 that works like Array.prototype.map
but for streams.
For when through2 is just too verbose :wink:
Note you will NOT be able to skip chunks. This is intended for modification only. If you want filter the stream content, use either through2
or through2-filter
. This transform also does not have a flush
function.
IMPORTANT: If you return null
from your function, the stream will end there.
var map = require("@zitterorg/reiciendis-ex-fuga")
var truncate = map(function (chunk) {
return chunk.slice(0, 10)
})
// vs. with through2:
var truncate = through2(function (chunk, encoding, callback) {
this.push(chunk.slice(0, 10))
return callback()
})
// Then use your map:
source.pipe(truncate).pipe(sink)
// Additionally accepts `wantStrings` argument to convert buffers into strings
var stripTags = map({wantStrings: true}, function (str) {
// OMG don't actually use this
return str.replace(/<.*?>/g, "")
})
// Works like `Array.prototype.map` meaning you can specify a function that
// takes up to two* arguments: fn(chunk, index)
var spaceout = map({wantStrings: true}, function (chunk, index) {
return (index % 2 == 0) ? chunk + "\n\n" : chunk
})
// vs. with through2:
var spaceout = through2(function (chunk, encoding, callback) {
if (this.index == undefined) this.index = 0
var buf = (this.index++ % 2 == 0) ? Buffer.concat(chunk, new Buffer("\n\n")) : chunk
this.push(buf)
return callback()
})
*Differences from Array.prototype.map
:
- Cannot insert
null
elements into the stream without aborting. - No third
array
callback argument. That would require realizing the entire stream, which is generally counter-productive to stream operations. Array.prototype.map
doesn't modify the source Array, which is somewhat nonsensical when applied to streams.
API
require("@zitterorg/reiciendis-ex-fuga")([options,] fn)
Create a stream.Transform
instance that will call fn(chunk, index)
on each stream segment.
var Tx = require("@zitterorg/reiciendis-ex-fuga").ctor([options,] fn)
Create a reusable stream.Transform
TYPE that can be called via new Tx
or Tx()
to create an instance.
require("@zitterorg/reiciendis-ex-fuga").obj([options,] fn)
Create a @zitterorg/reiciendis-ex-fuga
instance that defaults to objectMode: true
.
require("@zitterorg/reiciendis-ex-fuga").objCtor([options,] fn)
Just like ctor, but with objectMode: true
defaulting to true.
Options
- wantStrings: Automatically call chunk.toString() for the super lazy.
- all other through2 options
LICENSE
MIT
6 days ago
8 days ago
9 days ago
10 days ago
7 days ago
12 days ago
13 days ago
11 days ago
14 days ago
15 days ago
25 days ago
24 days ago
18 days ago
16 days ago
17 days ago
23 days ago
21 days ago
22 days ago
19 days ago
20 days ago
26 days ago
27 days ago
1 month ago
28 days ago
1 month ago
29 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago