@naturalcycles/nodejs-lib 13.3.0 → 13.4.0

package/dist/stream/pipeline/pipeline.d.ts

@@ -9,6 +9,14 @@ export interface PipelineOptions {
      * Required to support graceful close when using transformLimit
      */
     allowClose?: boolean;
+    /**
+     * Set to true to allow graceful abort (via AbortSignal).
+     * "Graceful" means it'll swallow the AbortError and let the pipeline resolve normally.
+     *
+     * Default is false - AbortError will be thrown.
+     */
+    allowGracefulAbort?: boolean;
+    signal?: AbortSignal;
 }
 /**
  * Promisified `stream.pipeline`.

package/dist/stream/pipeline/pipeline.js

@@ -45,7 +45,7 @@ async function _pipeline(streams, opt = {}) {
         };
         rest.forEach(s => {
             // console.log(s)
-            if (s instanceof AbortableTransform || s.constructor.name === 'DestroyableTransform') {
+            if (s instanceof AbortableTransform || s.constructor.name === 'AbortableTransform') {
                 // console.log(`found ${s.constructor.name}, setting props`)
                 ;
                 s.sourceReadable = sourceReadable;
@@ -54,13 +54,17 @@ async function _pipeline(streams, opt = {}) {
         });
     }
     try {
-        return await (0, promises_1.pipeline)(first, ...rest);
+        return await (0, promises_1.pipeline)([first, ...rest], opt);
     }
     catch (err) {
         if (opt.allowClose && err?.code === 'ERR_STREAM_PREMATURE_CLOSE') {
             console.log('_pipeline closed (as expected)');
             return;
         }
+        if (opt.allowGracefulAbort && err?.name === 'AbortError') {
+            console.log('_pipeline closed via AbortSignal (as expected)');
+            return;
+        }
         // console.log(`_pipeline error`, err)
         throw err;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "13.3.0",
+  "version": "13.4.0",
   "scripts": {
     "prepare": "husky install",
     "docs-serve": "vuepress dev docs",

package/src/stream/pipeline/pipeline.ts

@@ -11,6 +11,16 @@ export interface PipelineOptions {
    * Required to support graceful close when using transformLimit
    */
   allowClose?: boolean
+
+  /**
+   * Set to true to allow graceful abort (via AbortSignal).
+   * "Graceful" means it'll swallow the AbortError and let the pipeline resolve normally.
+   *
+   * Default is false - AbortError will be thrown.
+   */
+  allowGracefulAbort?: boolean
+
+  signal?: AbortSignal
 }
 
 /**
@@ -55,7 +65,7 @@ export async function _pipeline(streams: AnyStream[], opt: PipelineOptions = {})
 
     rest.forEach(s => {
       // console.log(s)
-      if (s instanceof AbortableTransform || s.constructor.name === 'DestroyableTransform') {
+      if (s instanceof AbortableTransform || s.constructor.name === 'AbortableTransform') {
         // console.log(`found ${s.constructor.name}, setting props`)
         ;(s as AbortableTransform).sourceReadable = sourceReadable
         ;(s as AbortableTransform).streamDone = streamDone
@@ -64,12 +74,18 @@ export async function _pipeline(streams: AnyStream[], opt: PipelineOptions = {})
   }
 
   try {
-    return await pipeline(first, ...(rest as any[]))
+    return await pipeline([first, ...rest], opt)
   } catch (err) {
     if (opt.allowClose && (err as any)?.code === 'ERR_STREAM_PREMATURE_CLOSE') {
       console.log('_pipeline closed (as expected)')
       return
     }
+
+    if (opt.allowGracefulAbort && (err as any)?.name === 'AbortError') {
+      console.log('_pipeline closed via AbortSignal (as expected)')
+      return
+    }
+
     // console.log(`_pipeline error`, err)
     throw err
   }