Merge branch 'dev' into master
This commit is contained in:
commit
fc5b96f725
138
README.md
138
README.md
@ -2,11 +2,14 @@
|
|||||||
|
|
||||||
**Dependency-free stream utils for Node.js**
|
**Dependency-free stream utils for Node.js**
|
||||||
|
|
||||||
<sub>Released under the [MIT](https://git.lewis.id/strom/blob/master/LICENSE) license.</sub>
|
<sub>Released under the [MIT](LICENSE) license.</sub>
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
yarn add stromjs
|
yarn add stromjs
|
||||||
```
|
```
|
||||||
|
```sh
|
||||||
|
npm add stromjs
|
||||||
|
```
|
||||||
|
|
||||||
## fromArray(array)
|
## fromArray(array)
|
||||||
Convert an array into a `Readable` stream of its elements
|
Convert an array into a `Readable` stream of its elements
|
||||||
@ -23,7 +26,7 @@ strom.fromArray(["a", "b"])
|
|||||||
|
|
||||||
|
|
||||||
## map(mapper, options)
|
## map(mapper, options)
|
||||||
Return a `ReadWrite` stream that maps streamed chunks
|
Returns a `ReadWrite` stream that maps streamed chunks
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@ -41,7 +44,7 @@ strom.fromArray(["a", "b"])
|
|||||||
|
|
||||||
|
|
||||||
## flatMap(mapper, options)
|
## flatMap(mapper, options)
|
||||||
Return a `ReadWrite` stream that flat maps streamed chunks
|
Returns a `ReadWrite` stream that flat maps streamed chunks
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@ -59,7 +62,7 @@ strom.fromArray(["a", "AA"])
|
|||||||
|
|
||||||
|
|
||||||
## filter(predicate, options)
|
## filter(predicate, options)
|
||||||
Return a `ReadWrite` stream that filters out streamed chunks for which the predicate does not hold
|
Returns a `ReadWrite` stream that filters out streamed chunks for which the predicate does not hold
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@ -76,7 +79,7 @@ strom.fromArray(["a", "b", "c"])
|
|||||||
|
|
||||||
|
|
||||||
## reduce(iteratee, initialValue, options)
|
## reduce(iteratee, initialValue, options)
|
||||||
Return a `ReadWrite` stream that reduces streamed chunks down to a single value and yield that
|
Returns a `ReadWrite` stream that reduces streamed chunks down to a single value and yield that
|
||||||
value
|
value
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
@ -97,7 +100,7 @@ strom.fromArray(["a", "b", "cc"])
|
|||||||
|
|
||||||
|
|
||||||
## split(separator)
|
## split(separator)
|
||||||
Return a `ReadWrite` stream that splits streamed chunks using the given separator
|
Returns a `ReadWrite` stream that splits streamed chunks using the given separator
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@ -115,7 +118,7 @@ strom.fromArray(["a,b", "c,d"])
|
|||||||
|
|
||||||
|
|
||||||
## join(separator)
|
## join(separator)
|
||||||
Return a `ReadWrite` stream that joins streamed chunks using the given separator
|
Returns a `ReadWrite` stream that joins streamed chunks using the given separator
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@ -132,7 +135,7 @@ strom.fromArray(["a", "b", "c"])
|
|||||||
|
|
||||||
|
|
||||||
## replace(searchValue, replaceValue)
|
## replace(searchValue, replaceValue)
|
||||||
Return a `ReadWrite` stream that replaces occurrences of the given string or regular expression in
|
Returns a `ReadWrite` stream that replaces occurrences of the given string or regular expression in
|
||||||
the streamed chunks with the specified replacement string
|
the streamed chunks with the specified replacement string
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
@ -151,7 +154,7 @@ strom.fromArray(["a1", "b22", "c333"])
|
|||||||
|
|
||||||
|
|
||||||
## parse()
|
## parse()
|
||||||
Return a `ReadWrite` stream that parses the streamed chunks as JSON
|
Returns a `ReadWrite` stream that parses the streamed chunks as JSON
|
||||||
|
|
||||||
```js
|
```js
|
||||||
strom.fromArray(['{ "a": "b" }'])
|
strom.fromArray(['{ "a": "b" }'])
|
||||||
@ -162,7 +165,7 @@ strom.fromArray(['{ "a": "b" }'])
|
|||||||
|
|
||||||
|
|
||||||
## stringify()
|
## stringify()
|
||||||
Return a `ReadWrite` stream that stringifies the streamed chunks to JSON
|
Returns a `ReadWrite` stream that stringifies the streamed chunks to JSON
|
||||||
|
|
||||||
```js
|
```js
|
||||||
strom.fromArray([{ a: "b" }])
|
strom.fromArray([{ a: "b" }])
|
||||||
@ -173,7 +176,7 @@ strom.fromArray([{ a: "b" }])
|
|||||||
|
|
||||||
|
|
||||||
## collect(options)
|
## collect(options)
|
||||||
Return a `ReadWrite` stream that collects streamed chunks into an array or buffer
|
Returns a `ReadWrite` stream that collects streamed chunks into an array or buffer
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@ -189,7 +192,7 @@ strom.fromArray(["a", "b", "c"])
|
|||||||
|
|
||||||
|
|
||||||
## concat(streams)
|
## concat(streams)
|
||||||
Return a `Readable` stream of readable streams concatenated together
|
Returns a `Readable` stream of readable streams concatenated together
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@ -210,7 +213,7 @@ source2.push(null);
|
|||||||
|
|
||||||
|
|
||||||
## merge(streams)
|
## merge(streams)
|
||||||
Return a `Readable` stream of readable streams merged together in chunk arrival order
|
Returns a `Readable` stream of readable streams merged together in chunk arrival order
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@ -231,7 +234,7 @@ setTimeout(() => source2.push(null), 50);
|
|||||||
|
|
||||||
|
|
||||||
## duplex(writable, readable)
|
## duplex(writable, readable)
|
||||||
Return a `Duplex` stream from a writable stream that is assumed to somehow, when written to,
|
Returns a `Duplex` stream from a writable stream that is assumed to somehow, when written to,
|
||||||
cause the given readable stream to yield chunks
|
cause the given readable stream to yield chunks
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
@ -249,7 +252,7 @@ strom.fromArray(["a", "b", "c"])
|
|||||||
|
|
||||||
|
|
||||||
## child(childProcess)
|
## child(childProcess)
|
||||||
Return a `Duplex` stream from a child process' stdin and stdout
|
Returns a `Duplex` stream from a child process' stdin and stdout
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@ -265,7 +268,7 @@ strom.fromArray(["a", "b", "c"])
|
|||||||
|
|
||||||
|
|
||||||
## last(readable)
|
## last(readable)
|
||||||
Return a `Promise` resolving to the last streamed chunk of the given readable stream, after it has
|
Returns a `Promise` resolving to the last streamed chunk of the given readable stream, after it has
|
||||||
ended
|
ended
|
||||||
|
|
||||||
| Param | Type | Description |
|
| Param | Type | Description |
|
||||||
@ -280,3 +283,106 @@ let f = async () => {
|
|||||||
f();
|
f();
|
||||||
// c is printed out
|
// c is printed out
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## accumulator(flushStrategy, iteratee, options)
|
||||||
|
TO BE DOCUMENTED
|
||||||
|
|
||||||
|
## batch(batchSize, maxBatchAge, options)
|
||||||
|
Returns a `Transform` stream which produces all incoming data in batches of size `batchSize`.
|
||||||
|
|
||||||
|
| Param | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `batchSize` | `number` | Size of the batches to be produced |
|
||||||
|
| `maxBatchAge` | `number` | Maximum number of milliseconds a message will be queued for. E.g. a batch will be produced before reaching `batchSize` if the first message queued is `maxBatchAge` ms old or more |
|
||||||
|
| `options` | `TransformOptions` | Options passed down to the Transform object |
|
||||||
|
|
||||||
|
```js
|
||||||
|
strom.fromArray(["a", "b", "c", "d"])
|
||||||
|
.pipe(strom.batch(3, 500))
|
||||||
|
.pipe(process.stdout);
|
||||||
|
// ["a","b","c"]
|
||||||
|
// ["d"] //After 500ms
|
||||||
|
```
|
||||||
|
|
||||||
|
## compose(streams, errorCb, options)
|
||||||
|
|
||||||
|
Returns a `Transform` stream which consists of all `streams` but behaves as a single stream. The returned stream can be piped into and from transparently.
|
||||||
|
|
||||||
|
| Param | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `streams` | `Array` | Streams to be composed |
|
||||||
|
| `errorCb` | `(err: Error) => void` | Function called when an error occurs in any of the streams |
|
||||||
|
| `options` | `TransformOptions` | Options passed down to the Transform object |
|
||||||
|
|
||||||
|
```js
|
||||||
|
const composed = strom.compose([
|
||||||
|
strom.split(),
|
||||||
|
strom.map(data => data.trim()),
|
||||||
|
strom.filter(str => !!str),
|
||||||
|
strom.parse(),
|
||||||
|
strom.flatMap(data => data),
|
||||||
|
strom.stringify(),
|
||||||
|
]);
|
||||||
|
|
||||||
|
const data = ["[1,2,3] \n [4,5,6] ", "\n [7,8,9] \n\n"];
|
||||||
|
|
||||||
|
strom.fromArray(data).pipe(composed).pipe(process.stdout);
|
||||||
|
// 123456789
|
||||||
|
```
|
||||||
|
|
||||||
|
## demux(pipelineConstructor, demuxBy, options)
|
||||||
|
TO BE DOCUMENTED
|
||||||
|
|
||||||
|
## parallelMap(mapper, parallel, sleepTime, options)
|
||||||
|
Returns a `Transform` stream which maps incoming data through the async mapper with the given parallelism.
|
||||||
|
|
||||||
|
| Param | Type | Description | Default |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| `mapper` | `async (chunk: T, encoding: string) => R` | Mapper function, mapping each (chunk, encoding) to a new chunk (non-async will not be parallelized) | -- |
|
||||||
|
| `parallel` | `number` | Number of concurrent executions of the mapper allowed | 10 |
|
||||||
|
| `sleepTime` | `number` | Number of milliseconds to wait before testing if more messages can be processed | 1 |
|
||||||
|
|
||||||
|
```js
|
||||||
|
function sleep(time) {
|
||||||
|
return time > 0 ? new Promise(resolve => setTimeout(resolve, time)) : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
strom
|
||||||
|
.fromArray([1, 2, 3, 4, 6, 8])
|
||||||
|
.pipe(
|
||||||
|
strom.parallelMap(async d => {
|
||||||
|
await sleep(10000 - d * 1000);
|
||||||
|
return `${d}`;
|
||||||
|
}, 3),
|
||||||
|
)
|
||||||
|
.pipe(process.stdout);
|
||||||
|
|
||||||
|
// 321864
|
||||||
|
```
|
||||||
|
|
||||||
|
## rate()
|
||||||
|
|
||||||
|
|
||||||
|
```js
|
||||||
|
const strom = require("stromjs").strom();
|
||||||
|
|
||||||
|
function sleep(time) {
|
||||||
|
return time > 0 ? new Promise(resolve => setTimeout(resolve, time)) : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const rate = strom.rate(2, 1, { behavior: 1 });
|
||||||
|
rate.pipe(strom.map(x => console.log(x)));
|
||||||
|
async function produce() {
|
||||||
|
rate.write(1);
|
||||||
|
await sleep(500);
|
||||||
|
rate.write(2);
|
||||||
|
await sleep(500);
|
||||||
|
rate.write(3);
|
||||||
|
rate.write(4);
|
||||||
|
rate.write(5);
|
||||||
|
await sleep(500);
|
||||||
|
rate.write(6);
|
||||||
|
}
|
||||||
|
|
||||||
|
produce();
|
||||||
|
```
|
||||||
|
14
package.json
14
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "stromjs",
|
"name": "stromjs",
|
||||||
"version": "2.0.0-alpha.1",
|
"version": "0.5.1",
|
||||||
"description": "Dependency-free streams utils for Node.js",
|
"description": "Dependency-free streams utils for Node.js",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"promise",
|
"promise",
|
||||||
@ -9,10 +9,18 @@
|
|||||||
],
|
],
|
||||||
"contributors": [
|
"contributors": [
|
||||||
{
|
{
|
||||||
"name": "Wenzil"
|
"name": "Sami Turcotte",
|
||||||
|
"url": "https://github.com/Wenzil"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Lewis Diamond"
|
"name": "Jerry Kurian",
|
||||||
|
"email": "jerrykurian@protonmail.com",
|
||||||
|
"url": "https://github.com/jkurian"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Lewis Diamond",
|
||||||
|
"email": "stromjs@lewisdiamond.com",
|
||||||
|
"url": "https://github.com/lewisdiamond"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
|
15
samples/parallelMap.js
Normal file
15
samples/parallelMap.js
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
const strom = require("stromjs").strom();
|
||||||
|
|
||||||
|
function sleep(time) {
|
||||||
|
return time > 0 ? new Promise(resolve => setTimeout(resolve, time)) : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
strom
|
||||||
|
.fromArray([1, 2, 3, 4, 6, 8])
|
||||||
|
.pipe(
|
||||||
|
strom.parallelMap(async d => {
|
||||||
|
await sleep(10000 - d * 1000);
|
||||||
|
return `${d}`;
|
||||||
|
}, 3),
|
||||||
|
)
|
||||||
|
.pipe(process.stdout);
|
21
samples/rate.js
Normal file
21
samples/rate.js
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
const strom = require("../dist/index.js");
|
||||||
|
|
||||||
|
function sleep(time) {
|
||||||
|
return time > 0 ? new Promise(resolve => setTimeout(resolve, time)) : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const rate = strom.rate(2, 1, { behavior: 1 });
|
||||||
|
rate.pipe(strom.map(x => console.log(x)));
|
||||||
|
async function produce() {
|
||||||
|
rate.write(1);
|
||||||
|
await sleep(500);
|
||||||
|
rate.write(2);
|
||||||
|
await sleep(500);
|
||||||
|
rate.write(3);
|
||||||
|
rate.write(4);
|
||||||
|
rate.write(5);
|
||||||
|
await sleep(500);
|
||||||
|
rate.write(6);
|
||||||
|
}
|
||||||
|
|
||||||
|
produce();
|
@ -2,7 +2,7 @@ import { Transform, TransformOptions } from "stream";
|
|||||||
|
|
||||||
export function batch(
|
export function batch(
|
||||||
batchSize: number = 1000,
|
batchSize: number = 1000,
|
||||||
maxBatchAge: number = 500,
|
maxBatchAge: number = 0,
|
||||||
options: TransformOptions = {},
|
options: TransformOptions = {},
|
||||||
): Transform {
|
): Transform {
|
||||||
let buffer: any[] = [];
|
let buffer: any[] = [];
|
||||||
@ -23,7 +23,7 @@ export function batch(
|
|||||||
buffer.push(chunk);
|
buffer.push(chunk);
|
||||||
if (buffer.length === batchSize) {
|
if (buffer.length === batchSize) {
|
||||||
sendChunk(this);
|
sendChunk(this);
|
||||||
} else {
|
} else if (maxBatchAge) {
|
||||||
if (timer === null) {
|
if (timer === null) {
|
||||||
timer = setInterval(() => {
|
timer = setInterval(() => {
|
||||||
sendChunk(this);
|
sendChunk(this);
|
||||||
|
@ -263,5 +263,10 @@ export function strom(defaultOptions: TransformOptions = { objectMode: true }) {
|
|||||||
* @param options Writable stream options
|
* @param options Writable stream options
|
||||||
*/
|
*/
|
||||||
demux: withDefaultOptions(2, demux),
|
demux: withDefaultOptions(2, demux),
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new strom instance overriding the defaults
|
||||||
|
*/
|
||||||
|
instance: strom,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
@ -2,20 +2,41 @@ import { Transform, TransformOptions } from "stream";
|
|||||||
import { performance } from "perf_hooks";
|
import { performance } from "perf_hooks";
|
||||||
import { sleep } from "../helpers";
|
import { sleep } from "../helpers";
|
||||||
|
|
||||||
|
export enum Behavior {
|
||||||
|
BUFFER = 0,
|
||||||
|
DROP = 1,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RateOptions {
|
||||||
|
window?: number;
|
||||||
|
behavior?: Behavior;
|
||||||
|
}
|
||||||
|
|
||||||
export function rate(
|
export function rate(
|
||||||
targetRate: number = 50,
|
targetRate: number = 50,
|
||||||
period: number = 1,
|
period: number = 1,
|
||||||
options?: TransformOptions,
|
options?: TransformOptions & RateOptions,
|
||||||
): Transform {
|
): Transform {
|
||||||
const deltaMS = ((1 / targetRate) * 1000) / period; // Skip a full period
|
const deltaMS = ((1 / targetRate) * 1000) / period; // Skip a full period
|
||||||
let total = 0;
|
let total = 0;
|
||||||
const start = performance.now();
|
const window = options?.window || Infinity;
|
||||||
|
const behavior = options?.behavior || Behavior.BUFFER;
|
||||||
|
let start = performance.now();
|
||||||
return new Transform({
|
return new Transform({
|
||||||
...options,
|
...options,
|
||||||
async transform(data, encoding, callback) {
|
async transform(data, encoding, callback) {
|
||||||
const currentRate = (total / (performance.now() - start)) * 1000;
|
const now = performance.now();
|
||||||
|
if (now - start >= window) {
|
||||||
|
start = now - window;
|
||||||
|
}
|
||||||
|
const currentRate = (total / (now - start)) * 1000;
|
||||||
if (targetRate && currentRate > targetRate) {
|
if (targetRate && currentRate > targetRate) {
|
||||||
await sleep(deltaMS);
|
if (behavior === Behavior.DROP) {
|
||||||
|
callback(undefined);
|
||||||
|
return;
|
||||||
|
} else {
|
||||||
|
await sleep(deltaMS);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
total += 1;
|
total += 1;
|
||||||
callback(undefined, data);
|
callback(undefined, data);
|
||||||
|
29
src/index.ts
29
src/index.ts
@ -1,2 +1,29 @@
|
|||||||
export { strom } from "./functions";
|
import { strom } from "./functions";
|
||||||
export * from "./utils";
|
export * from "./utils";
|
||||||
|
export const {
|
||||||
|
fromArray,
|
||||||
|
map,
|
||||||
|
flatMap,
|
||||||
|
filter,
|
||||||
|
reduce,
|
||||||
|
split,
|
||||||
|
join,
|
||||||
|
replace,
|
||||||
|
parse,
|
||||||
|
stringify,
|
||||||
|
collect,
|
||||||
|
concat,
|
||||||
|
merge,
|
||||||
|
duplex,
|
||||||
|
child,
|
||||||
|
last,
|
||||||
|
batch,
|
||||||
|
unbatch,
|
||||||
|
rate,
|
||||||
|
parallelMap,
|
||||||
|
accumulator,
|
||||||
|
accumulatorBy,
|
||||||
|
compose,
|
||||||
|
demux,
|
||||||
|
instance,
|
||||||
|
} = strom();
|
||||||
|
@ -1,10 +1,9 @@
|
|||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import { strom } from "../src";
|
import { accumulator, accumulatorBy } from "../src";
|
||||||
import { FlushStrategy } from "../src/functions/accumulator";
|
import { FlushStrategy } from "../src/functions/accumulator";
|
||||||
import { performance } from "perf_hooks";
|
import { performance } from "perf_hooks";
|
||||||
const { accumulator, accumulatorBy } = strom({ objectMode: true });
|
|
||||||
|
|
||||||
test.cb("accumulator() rolling", t => {
|
test.cb("accumulator() rolling", t => {
|
||||||
t.plan(3);
|
t.plan(3);
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { batch, map, fromArray } from "../src";
|
||||||
const { batch, map, fromArray } = strom({ objectMode: true });
|
|
||||||
|
|
||||||
test.cb("batch() batches chunks together", t => {
|
test.cb("batch() batches chunks together", t => {
|
||||||
t.plan(3);
|
t.plan(3);
|
||||||
@ -39,7 +38,7 @@ test.cb("batch() yields a batch after the timeout", t => {
|
|||||||
const expectedElements = [["a", "b"], ["c"], ["d"]];
|
const expectedElements = [["a", "b"], ["c"], ["d"]];
|
||||||
let i = 0;
|
let i = 0;
|
||||||
source
|
source
|
||||||
.pipe(batch(3))
|
.pipe(batch(3, 500))
|
||||||
.on("data", (element: string[]) => {
|
.on("data", (element: string[]) => {
|
||||||
t.deepEqual(element, expectedElements[i]);
|
t.deepEqual(element, expectedElements[i]);
|
||||||
i++;
|
i++;
|
||||||
|
@ -2,8 +2,7 @@ import * as cp from "child_process";
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { child } from "../src";
|
||||||
const { child } = strom();
|
|
||||||
|
|
||||||
test.cb(
|
test.cb(
|
||||||
"child() allows easily writing to child process stdin and reading from its stdout",
|
"child() allows easily writing to child process stdin and reading from its stdout",
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { collect } from "../src";
|
||||||
const { collect } = strom();
|
|
||||||
|
|
||||||
test.cb(
|
test.cb(
|
||||||
"collect() collects streamed elements into an array (object, flowing mode)",
|
"collect() collects streamed elements into an array (object, flowing mode)",
|
||||||
|
@ -2,9 +2,8 @@ import * as test from "ava";
|
|||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { sleep } from "../src/helpers";
|
import { sleep } from "../src/helpers";
|
||||||
import { Readable, Writable } from "stream";
|
import { Readable, Writable } from "stream";
|
||||||
import { strom } from "../src";
|
import { compose, map, fromArray } from "../src";
|
||||||
import { performance } from "perf_hooks";
|
import { performance } from "perf_hooks";
|
||||||
const { compose, map, fromArray } = strom({ objectMode: true });
|
|
||||||
|
|
||||||
test.cb("compose() chains two streams together in the correct order", t => {
|
test.cb("compose() chains two streams together in the correct order", t => {
|
||||||
t.plan(3);
|
t.plan(3);
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { concat, collect } from "../src";
|
||||||
const { concat, collect } = strom();
|
|
||||||
|
|
||||||
test.cb(
|
test.cb(
|
||||||
"concat() concatenates multiple readable streams (object, flowing mode)",
|
"concat() concatenates multiple readable streams (object, flowing mode)",
|
||||||
|
@ -1,21 +1,30 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { strom } from "../src";
|
import { batch as _batch, instance as strom } from "../src";
|
||||||
|
|
||||||
const withDefaultOptions = strom({ objectMode: true });
|
const withDefaultOptions = strom({ objectMode: false });
|
||||||
const withoutOptions = strom();
|
|
||||||
|
|
||||||
test("strom instances can have default options", t => {
|
test("strom instances can have default options", t => {
|
||||||
let batch = withDefaultOptions.batch();
|
let batch = withDefaultOptions.batch();
|
||||||
t.true(batch._readableState.objectMode);
|
t.false(batch._readableState.objectMode);
|
||||||
t.true(batch._writableState.objectMode);
|
t.false(batch._writableState.objectMode);
|
||||||
batch = withDefaultOptions.batch(3);
|
batch = withDefaultOptions.batch(3);
|
||||||
t.true(batch._readableState.objectMode);
|
t.false(batch._readableState.objectMode);
|
||||||
t.true(batch._writableState.objectMode);
|
t.false(batch._writableState.objectMode);
|
||||||
batch = withDefaultOptions.batch(3, 1);
|
batch = withDefaultOptions.batch(3, 1);
|
||||||
|
t.false(batch._readableState.objectMode);
|
||||||
|
t.false(batch._writableState.objectMode);
|
||||||
|
batch = withDefaultOptions.batch(3, 1, { objectMode: true });
|
||||||
t.true(batch._readableState.objectMode);
|
t.true(batch._readableState.objectMode);
|
||||||
t.true(batch._writableState.objectMode);
|
t.true(batch._writableState.objectMode);
|
||||||
batch = withDefaultOptions.batch(3, 1, { objectMode: false });
|
|
||||||
|
batch = _batch(3);
|
||||||
|
t.true(batch._readableState.objectMode);
|
||||||
|
t.true(batch._writableState.objectMode);
|
||||||
|
batch = _batch(3, 1);
|
||||||
|
t.true(batch._readableState.objectMode);
|
||||||
|
t.true(batch._writableState.objectMode);
|
||||||
|
batch = _batch(3, 1, { objectMode: false });
|
||||||
t.false(batch._readableState.objectMode);
|
t.false(batch._readableState.objectMode);
|
||||||
t.false(batch._writableState.objectMode);
|
t.false(batch._writableState.objectMode);
|
||||||
});
|
});
|
||||||
|
@ -1,11 +1,10 @@
|
|||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { demux, map, fromArray } from "../src";
|
||||||
import { Writable, Readable } from "stream";
|
import { Writable, Readable } from "stream";
|
||||||
import * as sinon from "sinon";
|
import * as sinon from "sinon";
|
||||||
import { sleep } from "../src/helpers";
|
import { sleep } from "../src/helpers";
|
||||||
import { performance } from "perf_hooks";
|
import { performance } from "perf_hooks";
|
||||||
const { demux, map, fromArray } = strom({ objectMode: true });
|
|
||||||
|
|
||||||
interface Test {
|
interface Test {
|
||||||
key: string;
|
key: string;
|
||||||
|
@ -2,8 +2,7 @@ import * as cp from "child_process";
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { duplex } from "../src";
|
||||||
const { duplex } = strom();
|
|
||||||
|
|
||||||
test.cb(
|
test.cb(
|
||||||
"duplex() combines a writable and readable stream into a ReadWrite stream",
|
"duplex() combines a writable and readable stream into a ReadWrite stream",
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import { strom } from "../src";
|
import { filter } from "../src";
|
||||||
const { filter } = strom();
|
|
||||||
|
|
||||||
test.cb("filter() filters elements synchronously", t => {
|
test.cb("filter() filters elements synchronously", t => {
|
||||||
t.plan(2);
|
t.plan(2);
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { flatMap } from "../src";
|
||||||
const { flatMap } = strom({ objectMode: true });
|
|
||||||
|
|
||||||
test.cb("flatMap() maps elements synchronously", t => {
|
test.cb("flatMap() maps elements synchronously", t => {
|
||||||
t.plan(6);
|
t.plan(6);
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { fromArray } from "../src";
|
||||||
const { fromArray } = strom();
|
|
||||||
|
|
||||||
test.cb("fromArray() streams array elements in flowing mode", t => {
|
test.cb("fromArray() streams array elements in flowing mode", t => {
|
||||||
t.plan(3);
|
t.plan(3);
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { join } from "../src";
|
||||||
const { join } = strom();
|
|
||||||
|
|
||||||
test.cb("join() joins chunks using the specified separator", t => {
|
test.cb("join() joins chunks using the specified separator", t => {
|
||||||
t.plan(9);
|
t.plan(9);
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { last } from "../src";
|
||||||
const { last } = strom();
|
|
||||||
|
|
||||||
test("last() resolves to the last chunk streamed by the given readable stream", async t => {
|
test("last() resolves to the last chunk streamed by the given readable stream", async t => {
|
||||||
const source = new Readable({ objectMode: true });
|
const source = new Readable({ objectMode: true });
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { map } from "../src";
|
||||||
const { map } = strom();
|
|
||||||
|
|
||||||
test.cb("map() maps elements synchronously", t => {
|
test.cb("map() maps elements synchronously", t => {
|
||||||
t.plan(3);
|
t.plan(3);
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { merge } from "../src";
|
||||||
const { merge } = strom();
|
|
||||||
|
|
||||||
test.cb(
|
test.cb(
|
||||||
"merge() merges multiple readable streams in chunk arrival order",
|
"merge() merges multiple readable streams in chunk arrival order",
|
||||||
|
@ -2,9 +2,8 @@ import { Readable } from "stream";
|
|||||||
import { performance } from "perf_hooks";
|
import { performance } from "perf_hooks";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { parallelMap } from "../src";
|
||||||
import { sleep } from "../src/helpers";
|
import { sleep } from "../src/helpers";
|
||||||
const { parallelMap } = strom({ objectMode: true });
|
|
||||||
|
|
||||||
test.cb("parallelMap() parallel mapping", t => {
|
test.cb("parallelMap() parallel mapping", t => {
|
||||||
t.plan(6);
|
t.plan(6);
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable, finished } from "stream";
|
import { Readable, finished } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { parse } from "../src";
|
||||||
const { parse } = strom();
|
|
||||||
|
|
||||||
test.cb("parse() parses the streamed elements as JSON", t => {
|
test.cb("parse() parses the streamed elements as JSON", t => {
|
||||||
t.plan(3);
|
t.plan(3);
|
||||||
|
@ -1,12 +1,11 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import { performance } from "perf_hooks";
|
import { performance } from "perf_hooks";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { rate } from "../src";
|
||||||
import { strom } from "../src";
|
import { sleep } from "../src/helpers";
|
||||||
const { rate } = strom({ objectMode: true });
|
|
||||||
|
|
||||||
test.cb("rate() sends data at a rate of 150", t => {
|
test.cb("rate() sends data at a rate of 150", t => {
|
||||||
t.plan(5);
|
t.plan(15);
|
||||||
const targetRate = 150;
|
const targetRate = 150;
|
||||||
const source = new Readable({ objectMode: true });
|
const source = new Readable({ objectMode: true });
|
||||||
const expectedElements = ["a", "b", "c", "d", "e"];
|
const expectedElements = ["a", "b", "c", "d", "e"];
|
||||||
@ -15,10 +14,10 @@ test.cb("rate() sends data at a rate of 150", t => {
|
|||||||
|
|
||||||
source
|
source
|
||||||
.pipe(rate(targetRate))
|
.pipe(rate(targetRate))
|
||||||
.on("data", (element: string[]) => {
|
.on("data", (element: string) => {
|
||||||
const currentRate = (i / (performance.now() - start)) * 1000;
|
const currentRate = (i / (performance.now() - start)) * 1000;
|
||||||
expect(element).to.deep.equal(expectedElements[i]);
|
t.is(element, expectedElements[i]);
|
||||||
expect(currentRate).lessThan(targetRate);
|
t.true(currentRate <= targetRate);
|
||||||
t.pass();
|
t.pass();
|
||||||
i++;
|
i++;
|
||||||
})
|
})
|
||||||
@ -34,7 +33,7 @@ test.cb("rate() sends data at a rate of 150", t => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test.cb("rate() sends data at a rate of 50", t => {
|
test.cb("rate() sends data at a rate of 50", t => {
|
||||||
t.plan(5);
|
t.plan(15);
|
||||||
const targetRate = 50;
|
const targetRate = 50;
|
||||||
const source = new Readable({ objectMode: true });
|
const source = new Readable({ objectMode: true });
|
||||||
const expectedElements = ["a", "b", "c", "d", "e"];
|
const expectedElements = ["a", "b", "c", "d", "e"];
|
||||||
@ -43,10 +42,10 @@ test.cb("rate() sends data at a rate of 50", t => {
|
|||||||
|
|
||||||
source
|
source
|
||||||
.pipe(rate(targetRate))
|
.pipe(rate(targetRate))
|
||||||
.on("data", (element: string[]) => {
|
.on("data", (element: string) => {
|
||||||
const currentRate = (i / (performance.now() - start)) * 1000;
|
const currentRate = (i / (performance.now() - start)) * 1000;
|
||||||
expect(element).to.deep.equal(expectedElements[i]);
|
t.is(element, expectedElements[i]);
|
||||||
expect(currentRate).lessThan(targetRate);
|
t.true(currentRate <= targetRate);
|
||||||
t.pass();
|
t.pass();
|
||||||
i++;
|
i++;
|
||||||
})
|
})
|
||||||
@ -62,7 +61,7 @@ test.cb("rate() sends data at a rate of 50", t => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test.cb("rate() sends data at a rate of 1", t => {
|
test.cb("rate() sends data at a rate of 1", t => {
|
||||||
t.plan(5);
|
t.plan(15);
|
||||||
const targetRate = 1;
|
const targetRate = 1;
|
||||||
const source = new Readable({ objectMode: true });
|
const source = new Readable({ objectMode: true });
|
||||||
const expectedElements = ["a", "b", "c", "d", "e"];
|
const expectedElements = ["a", "b", "c", "d", "e"];
|
||||||
@ -71,10 +70,10 @@ test.cb("rate() sends data at a rate of 1", t => {
|
|||||||
|
|
||||||
source
|
source
|
||||||
.pipe(rate(targetRate))
|
.pipe(rate(targetRate))
|
||||||
.on("data", (element: string[]) => {
|
.on("data", (element: string) => {
|
||||||
const currentRate = (i / (performance.now() - start)) * 1000;
|
const currentRate = (i / (performance.now() - start)) * 1000;
|
||||||
expect(element).to.deep.equal(expectedElements[i]);
|
t.is(element, expectedElements[i]);
|
||||||
expect(currentRate).lessThan(targetRate);
|
t.true(currentRate <= targetRate);
|
||||||
t.pass();
|
t.pass();
|
||||||
i++;
|
i++;
|
||||||
})
|
})
|
||||||
@ -88,3 +87,41 @@ test.cb("rate() sends data at a rate of 1", t => {
|
|||||||
source.push("e");
|
source.push("e");
|
||||||
source.push(null);
|
source.push(null);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("rate() sends data at a rate of 1 and drops extra messages", async t => {
|
||||||
|
t.plan(9);
|
||||||
|
const targetRate = 1;
|
||||||
|
const source = new Readable({
|
||||||
|
objectMode: true,
|
||||||
|
read: () => {
|
||||||
|
return;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const expectedElements = ["a", "b", "e"];
|
||||||
|
const start = performance.now();
|
||||||
|
let i = 0;
|
||||||
|
|
||||||
|
let plan = 0;
|
||||||
|
source
|
||||||
|
.pipe(rate(targetRate, 1, { behavior: 1 }))
|
||||||
|
.on("data", (element: string) => {
|
||||||
|
const currentRate = (i / (performance.now() - start)) * 1000;
|
||||||
|
t.is(element, expectedElements[i]);
|
||||||
|
t.true(currentRate <= targetRate);
|
||||||
|
plan++;
|
||||||
|
t.pass();
|
||||||
|
i++;
|
||||||
|
})
|
||||||
|
.on("error", t.fail)
|
||||||
|
.on("end", t.fail);
|
||||||
|
|
||||||
|
source.push("a");
|
||||||
|
await sleep(1000);
|
||||||
|
source.push("b");
|
||||||
|
source.push("c");
|
||||||
|
source.push("d");
|
||||||
|
await sleep(1000);
|
||||||
|
source.push("e");
|
||||||
|
await sleep(1000);
|
||||||
|
source.push(null);
|
||||||
|
});
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { reduce } from "../src";
|
||||||
const { reduce } = strom({ objectMode: true });
|
|
||||||
|
|
||||||
test.cb("reduce() reduces elements synchronously", t => {
|
test.cb("reduce() reduces elements synchronously", t => {
|
||||||
t.plan(1);
|
t.plan(1);
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { replace } from "../src";
|
||||||
const { replace } = strom();
|
|
||||||
|
|
||||||
test.cb(
|
test.cb(
|
||||||
"replace() replaces occurrences of the given string in the streamed elements with the specified " +
|
"replace() replaces occurrences of the given string in the streamed elements with the specified " +
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { split } from "../src";
|
||||||
const { split } = strom();
|
|
||||||
|
|
||||||
test.cb("split() splits chunks using the default separator (\\n)", t => {
|
test.cb("split() splits chunks using the default separator (\\n)", t => {
|
||||||
t.plan(5);
|
t.plan(5);
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { stringify } from "../src";
|
||||||
const { stringify } = strom();
|
|
||||||
|
|
||||||
test.cb("stringify() stringifies the streamed elements as JSON", t => {
|
test.cb("stringify() stringifies the streamed elements as JSON", t => {
|
||||||
t.plan(4);
|
t.plan(4);
|
||||||
|
@ -1,8 +1,7 @@
|
|||||||
import { Readable } from "stream";
|
import { Readable } from "stream";
|
||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { expect } from "chai";
|
import { expect } from "chai";
|
||||||
import { strom } from "../src";
|
import { unbatch, batch } from "../src";
|
||||||
const { unbatch, batch } = strom({ objectMode: true });
|
|
||||||
|
|
||||||
test.cb("unbatch() unbatches", t => {
|
test.cb("unbatch() unbatches", t => {
|
||||||
t.plan(3);
|
t.plan(3);
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
import test from "ava";
|
import test from "ava";
|
||||||
import { collected } from "../../src/utils";
|
import { collected } from "../../src/utils";
|
||||||
import { strom } from "../../src";
|
import { fromArray, collect } from "../../src";
|
||||||
const { fromArray, collect } = strom({ objectMode: true });
|
|
||||||
|
|
||||||
test("collected returns a promise for the first data point", async t => {
|
test("collected returns a promise for the first data point", async t => {
|
||||||
const data = collected(fromArray([1, 2, 3, 4]).pipe(collect()));
|
const data = collected(fromArray([1, 2, 3, 4]).pipe(collect()));
|
||||||
|
Loading…
Reference in New Issue
Block a user