Rename transformIntoStream into transformStream

bguerout · Nov 24, 2022 · 26db57f · 26db57f
1 parent 37ce424
commit 26db57f
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -95,7 +95,7 @@ for await (const data of csvStream) {
 * [transformData](#transformdatacallback-options)
 * [transformIntoCSV](#transformintocsvoptions)
 * [transformIntoJSON](#transformintojsonoptions)
-* [transformIntoStream](#transformintostreamoptions)
+* [transformStream](#transformstreamoptions)
 * [writeData](#writedatacallback-options)
 
 ## accumulateData(callback, [options])
@@ -633,7 +633,7 @@ Robert Hue|2021-03-12T21:34:13.085Z
 `
 ```
 
-## transformIntoStream([options])
+## transformStream([options])
 
 Allows chunks of a sub-stream to be streamed as if each was part of the source
 
@@ -646,7 +646,7 @@ Allows chunks of a sub-stream to be streamed as if each was part of the source
 #### Examples
 
 ```js
-const { oleoduc, transformIntoStream, writeData } = require("oleoduc");
+const { oleoduc, transformStream, writeData } = require("oleoduc");
 const { Readable } = require("stream");
 
 const source = createStream();
@@ -655,7 +655,7 @@ source.push(null);
 
 await oleoduc(
   source,
-  transformIntoStream(data => {
+  transformStream(data => {
     var array = getListOfPeopleLivingInTheHouse();
     return Readable.from(array); //Return a stream
   }),

diff --git a/index.js b/index.js
@@ -3,7 +3,7 @@ module.exports.compose = require("./lib/compose.js").compose;
 module.exports.transformData = require("./lib/transformData.js").transformData;
 module.exports.transformIntoJSON = require("./lib/transformIntoJSON.js").transformIntoJSON;
 module.exports.transformIntoCSV = require("./lib/transformIntoCSV.js").transformIntoCSV;
-module.exports.transformIntoStream = require("./lib/transformIntoStream.js").transformIntoStream;
+module.exports.transformStream = require("./lib/transformStream.js").transformStream;
 module.exports.filterData = require("./lib/filterData.js").filterData;
 module.exports.accumulateData = require("./lib/accumulateData.js").accumulateData;
 module.exports.groupData = require("./lib/groupData.js").groupData;

diff --git a/lib/transformIntoStream.js → lib/transformStream.js b/lib/transformIntoStream.js → lib/transformStream.js
@@ -39,8 +39,8 @@ class TransformStream extends Transform {
   }
 }
 
-function transformIntoStream(handleChunk, options = {}) {
+function transformStream(handleChunk, options = {}) {
   return new TransformStream(handleChunk, { objectMode: true, ...options });
 }
 
-module.exports = { transformIntoStream };
+module.exports = { transformStream };
diff --git a/test/transformIntoStream-test.js → test/transformStream-test.js b/test/transformIntoStream-test.js → test/transformStream-test.js
@@ -1,17 +1,17 @@
 const assert = require("assert");
 const { streamArray, createStream, delay } = require("./testUtils.js");
 const { writeData } = require("../index.js");
-const { transformIntoStream } = require("../lib/transformIntoStream.js");
+const { transformStream } = require("../lib/transformStream.js");
 const SlowStream = require("slow-stream"); // eslint-disable-line node/no-unpublished-require
 
-describe("transformIntoStream", () => {
+describe("transformStream", () => {
   it("should transform data into a stream", (done) => {
     const chunks = [];
     const source = streamArray(["andré", "bruno"]);
 
     source
       .pipe(
-        transformIntoStream((data) => {
+        transformStream((data) => {
           const source = createStream();
           source.push(data + "_transformed");
           source.push(null);
@@ -35,7 +35,7 @@ describe("transformIntoStream", () => {
 
     source
       .pipe(
-        transformIntoStream((data) => {
+        transformStream((data) => {
           const source = createStream();
 
           return delay(() => {
@@ -62,7 +62,7 @@ describe("transformIntoStream", () => {
 
     source
       .pipe(
-        transformIntoStream(
+        transformStream(
           async (data) => {
             const source = createStream();
             for (let i = 0; i < 5; i++) {