feat: Make public a way to break/abort flow of a pipeline

With this, returning a "pipelineBreak" in a composed function of pipeline (or flow) will prevent execution of succeeding functions, while the pipeline also returns pipelineBreak.
ogre-works · Oct 9, 2023 · 30b58d9 · 30b58d9
1 parent e8f4f41
commit 30b58d9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/packages/fp/index.d.ts b/packages/fp/index.d.ts
@@ -120,3 +120,5 @@ interface GetFrom {
 
 export const getFrom: GetFrom;
 export const getSafeFrom: GetFrom;
+
+export const pipelineBreak: Symbol;
diff --git a/packages/fp/index.js b/packages/fp/index.js
@@ -1,5 +1,5 @@
 import awaitAll from './src/awaitAll/awaitAll';
-import flow from './src/flow/flow';
+import flow, { pipelineBreak } from './src/flow/flow';
 import isPromise from './src/isPromise/isPromise';
 import isPrimitive from './src/isPrimitive/isPrimitive';
 import pipeline from './src/pipeline/pipeline';
@@ -16,4 +16,5 @@ export {
   mapValuesDeep,
   getFrom,
   getSafeFrom,
+  pipelineBreak,
 };
Original file line number	Diff line number	Diff line change
Expand Up		@@ -120,3 +120,5 @@ interface GetFrom {

		export const getFrom: GetFrom;
		export const getSafeFrom: GetFrom;

		export const pipelineBreak: Symbol;