docs: ReduceStream 문서 작성

daengdaengLee · Aug 21, 2023 · 7516044 · 7516044
1 parent b22b7f3
commit 7516044
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -46,6 +46,23 @@ await pipeline(
 );
 ```
 
+### ReduceStream
+
+Accumulate the input data into the acc object.
+
+```typescript
+import { ReduceStream } from "utilitystreams";
+
+await pipeline(
+  arguments,
+  new ReduceStream(
+    { acc: "", f: (acc, cur) => `${acc} ${cur}` },
+    { objectMode: true },
+  ),
+  process.stdout,
+);
+```
+
 ### ToArrayStream
 
 Collects the input data into an array.