@temporalio/workflow 0.9.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +1 -1
- package/README.md +4 -2
- package/lib/cancellation-scope.d.ts +1 -1
- package/lib/cancellation-scope.js.map +1 -1
- package/lib/dependencies.d.ts +8 -56
- package/lib/dependencies.js +3 -49
- package/lib/dependencies.js.map +1 -1
- package/lib/index.d.ts +12 -12
- package/lib/index.js +13 -13
- package/lib/index.js.map +1 -1
- package/lib/interceptors.d.ts +8 -11
- package/lib/interfaces.d.ts +3 -1
- package/lib/internals.d.ts +39 -13
- package/lib/internals.js +75 -26
- package/lib/internals.js.map +1 -1
- package/lib/trigger.d.ts +3 -5
- package/lib/trigger.js +3 -5
- package/lib/trigger.js.map +1 -1
- package/lib/worker-interface.d.ts +15 -46
- package/lib/worker-interface.js +76 -112
- package/lib/worker-interface.js.map +1 -1
- package/lib/workflow-handle.d.ts +21 -20
- package/lib/workflow.d.ts +142 -23
- package/lib/workflow.js +169 -89
- package/lib/workflow.js.map +1 -1
- package/package.json +6 -6
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"worker-interface.js","sourceRoot":"","sources":["../src/worker-interface.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"worker-interface.js","sourceRoot":"","sources":["../src/worker-interface.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,+CAQ4B;AAC5B,2DAAwD;AAExD,2CAA2D;AAC3D,iCAA8B;AAC9B,qCAAqD;AAGrD,mDAAgE;AAEhE,SAAgB,cAAc,CAAC,EAA+C;IAC5E,iBAAK,CAAC,OAAO,GAAG,EAAE,CAAC;AACrB,CAAC;AAFD,wCAEC;AAED,SAAgB,eAAe;IAC7B,MAAM,MAAM,GAAG,UAAiB,CAAC;IACjC,0GAA0G;IAC1G,uEAAuE;IACvE,+EAA+E;IAC/E,MAAM,CAAC,OAAO,GAAG;QACf,MAAM,IAAI,kCAAyB,CAAC,wEAAwE,CAAC,CAAC;IAChH,CAAC,CAAC;IACF,MAAM,CAAC,oBAAoB,GAAG;QAC5B,MAAM,IAAI,kCAAyB,CACjC,qFAAqF,CACtF,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC;IAErC,MAAM,CAAC,IAAI,GAAG,UAAU,GAAG,IAAe;QACxC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACnB,OAAO,IAAK,YAAoB,CAAC,GAAG,IAAI,CAAC,CAAC;SAC3C;QACD,OAAO,IAAI,YAAY,CAAC,iBAAK,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC,CAAC;IAEF,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG;QAChB,OAAO,iBAAK,CAAC,GAAG,CAAC;IACnB,CAAC,CAAC;IAEF,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1D,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAEtD,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;IAE/C;;OAEG;IACH,MAAM,CAAC,UAAU,GAAG,UAAU,EAA2B,EAAE,EAAU,EAAE,GAAG,IAAW;QACnF,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACrB,MAAM,GAAG,GAAG,iBAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACnC,kGAAkG;QAClG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9B,iBAAK,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;YACtD,iBAAK,CAAC,WAAW,CAAC;gBAChB,UAAU,EAAE;oBACV,GAAG;oBACH,kBAAkB,EAAE,IAAA,eAAM,EAAC,EAAE,CAAC;iBAC/B;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC,IAAI,CACL,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,EACjB,GAAG,EAAE,CAAC,SAAS,CAAC,yBAAyB,CAC1C,CAAC;QACF,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IAEF,MAAM,CAAC,YAAY,GAAG,UAAU,MAAc;QAC5C,iBAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACvB,iBAAK,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACvC,iBAAK,CAAC,WAAW,CAAC;YAChB,WAAW,EAAE;gBACX,GAAG,EAAE,MAAM;aACZ;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,wDAAwD;IACxD,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,iBAAK,CAAC,MAAM,EAAE,CAAC;AACrC,CAAC;AAlED,0CAkEC;AAED;;;;GAIG;AACI,KAAK,UAAU,WAAW,CAC/B,IAAkB,EAClB,kBAA4B,EAC5B,cAAwB,EACxB,GAAW,EACX,gBAAkC;IAElC,8EAA8E;IAC9E,sJAAsJ;IACrJ,UAAkB,CAAC,OAAO,GAAG;QAC5B,MAAM,IAAI,kCAAyB,CAAC,wEAAwE,CAAC,CAAC;IAChH,CAAC,CAAC;IACF,iBAAK,CAAC,IAAI,GAAG,IAAI,CAAC;IAClB,iBAAK,CAAC,GAAG,GAAG,GAAG,CAAC;IAChB,iBAAK,CAAC,MAAM,GAAG,IAAA,WAAI,EAAC,cAAc,CAAC,CAAC;IACpC,2BAAW,CAAC,QAAQ,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAE3D,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,iBAAK,CAAC;IAC/B,IAAI,GAAG,KAAK,SAAS,EAAE;QACrB,MAAM,IAAI,0BAAiB,CAAC,mCAAmC,CAAC,CAAC;KAClE;IAED,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE;QACxC,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,CAAC;QAC/B,MAAM,OAAO,GAAgC,GAAG,CAAC,YAAY,CAAC;QAC9D,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;gBACjC,MAAM,IAAI,SAAS,CAAC,yCAAyC,OAAO,EAAE,CAAC,CAAC;aACzE;YACD,MAAM,YAAY,GAAG,OAAO,EAAE,CAAC;YAC/B,iBAAK,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;YACjE,iBAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC;YACnE,iBAAK,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC;SACtE;KACF;IAED,IAAI,QAAkB,CAAC;IACvB,IAAI;QACF,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,SAAS,CAAC,CAAC;QACjC,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAClC,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;YAClC,MAAM,IAAI,SAAS,CAAC,IAAI,IAAI,CAAC,YAAY,qBAAqB,CAAC,CAAC;SACjE;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,OAAO,GAAG,2BAAkB,CAAC,YAAY,CAAC,IAAA,qBAAY,EAAC,GAAG,CAAC,EAAE,gBAAgB,CAAC,CAAC;QACrF,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAA,iCAAqB,EAAC,OAAO,CAAC,CAAC;QAC/B,OAAO;KACR;IACD,iBAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC5B,CAAC;AAlDD,kCAkDC;AAMD;;;GAGG;AACI,KAAK,UAAU,QAAQ,CAAC,iBAA6B,EAAE,UAAkB;IAC9E,MAAM,UAAU,GAAG,iBAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;IAC/F,MAAM,SAAS,GAAG,IAAA,4BAAmB,EACnC,iBAAK,CAAC,YAAY,CAAC,SAAS,EAC5B,UAAU,EACV,KAAK,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,EAAE;QACnC,IAAI,UAAU,KAAK,CAAC,EAAE;YACpB,IAAI,iBAAK,CAAC,IAAI,KAAK,SAAS,EAAE;gBAC5B,MAAM,IAAI,0BAAiB,CAAC,mCAAmC,CAAC,CAAC;aAClE;YACD,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;gBACpB,MAAM,IAAI,SAAS,CAAC,6BAA6B,CAAC,CAAC;aACpD;YACD,IAAI,UAAU,CAAC,SAAS,KAAK,IAAI,EAAE;gBACjC,yEAAyE;gBACzE,iBAAK,CAAC,GAAG,GAAG,IAAA,eAAM,EAAC,UAAU,CAAC,SAAS,CAAC,CAAC;aAC1C;YACD,iBAAK,CAAC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,IAAI,KAAK,CAAC;SAC1D;QAED,0EAA0E;QAC1E,sEAAsE;QACtE,MAAM,IAAI,GAAG,UAAU,CAAC,IAAqD,CAAC;QAE9E,MAAM,OAAO,CAAC,GAAG,CACf,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACrB,IAAI,GAAG,CAAC,OAAO,KAAK,SAAS,EAAE;gBAC7B,MAAM,IAAI,SAAS,CAAC,oCAAoC,CAAC,CAAC;aAC3D;YACD,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACjC,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,SAAS,CAAC,gBAAgB,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC;aAC9D;YACD,wEAAwE;YACxE,sEAAsE;YACtE,8EAA8E;YAC9E,IAAI,iBAAK,CAAC,SAAS,IAAI,GAAG,CAAC,OAAO,KAAK,eAAe,EAAE;gBACtD,OAAO;aACR;YACD,MAAM,iBAAK,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,OAAc,CAAC,iDAAiD,CAAC,CAAC;YACrG,oBAAoB,EAAE,CAAC;QACzB,CAAC,CAAC,CACH,CAAC;IACJ,CAAC,CACF,CAAC;IACF,MAAM,SAAS,CAAC;QACd,UAAU;QACV,UAAU;KACX,CAAC,CAAC;IAEH,OAAO;QACL,oBAAoB,EAAE,iBAAK,CAAC,iBAAiB,CAAC,IAAI;KACnD,CAAC;AACJ,CAAC;AArDD,4BAqDC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB;IAChC,MAAM,SAAS,GAAG,IAAA,4BAAmB,EAAC,iBAAK,CAAC,YAAY,CAAC,SAAS,EAAE,oBAAoB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAC5G,MAAM,EAAE,IAAI,EAAE,GAAG,iBAAK,CAAC;IACvB,MAAM,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC,EAAE,QAAQ,EAAE,iBAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC7D,iBAAK,CAAC,QAAQ,GAAG,EAAE,CAAC;IACpB,OAAO,iBAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,eAAe,CAAC;QACxE,KAAK,EAAE,IAAI,EAAE,KAAK;QAClB,UAAU,EAAE,EAAE,QAAQ,EAAE;KACzB,CAAC,CAAC,MAAM,EAAE,CAAC;AACd,CAAC;AATD,gDASC;AAED,SAAgB,wBAAwB;IACtC,OAAO,iBAAK,CAAC,wBAAwB,EAAE,CAAC;AAC1C,CAAC;AAFD,4DAEC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB;IAClC,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,SAAS;QACP,MAAM,aAAa,GAAG,YAAY,CAAC;QACnC,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,iBAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,EAAE;YAC3D,IAAI,IAAI,CAAC,EAAE,EAAE,EAAE;gBACb,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,YAAY,EAAE,CAAC;gBACf,qDAAqD;gBACrD,iBAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aACrC;SACF;QACD,IAAI,aAAa,KAAK,YAAY,EAAE;YAClC,MAAM;SACP;KACF;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAjBD,oDAiBC"}
|
package/lib/workflow-handle.d.ts
CHANGED
|
@@ -1,18 +1,19 @@
|
|
|
1
|
-
import { BaseWorkflowHandle,
|
|
1
|
+
import { BaseWorkflowHandle, SignalDefinition, Workflow } from '@temporalio/common';
|
|
2
2
|
/**
|
|
3
3
|
* Handle representing an external Workflow execution
|
|
4
4
|
*/
|
|
5
|
-
export interface ExternalWorkflowHandle
|
|
5
|
+
export interface ExternalWorkflowHandle {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
8
|
-
*
|
|
7
|
+
* Signal a running Workflow.
|
|
8
|
+
*
|
|
9
|
+
* @param def a signal definition as returned from {@link defineSignal} or signal name (string)
|
|
9
10
|
*
|
|
10
11
|
* @example
|
|
11
12
|
* ```ts
|
|
12
|
-
* await
|
|
13
|
+
* await handle.signal(incrementSignal, 3);
|
|
13
14
|
* ```
|
|
14
15
|
*/
|
|
15
|
-
signal:
|
|
16
|
+
signal<Args extends any[] = []>(def: SignalDefinition<Args> | string, ...args: Args): Promise<void>;
|
|
16
17
|
/**
|
|
17
18
|
* Cancel the external Workflow execution.
|
|
18
19
|
*
|
|
@@ -29,26 +30,26 @@ export interface ExternalWorkflowHandle<T extends Workflow> {
|
|
|
29
30
|
readonly runId?: string;
|
|
30
31
|
}
|
|
31
32
|
/**
|
|
32
|
-
*
|
|
33
|
+
* A client side handle to a single Workflow instance.
|
|
34
|
+
* It can be used to signal, wait for completion, and cancel a Workflow execution.
|
|
33
35
|
*
|
|
34
|
-
* Given
|
|
36
|
+
* Given the following Workflow definition:
|
|
35
37
|
* ```ts
|
|
36
|
-
* export
|
|
37
|
-
*
|
|
38
|
-
* signals: {
|
|
39
|
-
* increment(amount?: number): void;
|
|
40
|
-
* };
|
|
41
|
-
* }
|
|
38
|
+
* export const incrementSignal = defineSignal('increment');
|
|
39
|
+
* export async function counterWorkflow(initialValue: number): Promise<void>;
|
|
42
40
|
* ```
|
|
43
41
|
*
|
|
44
|
-
*
|
|
42
|
+
* Start a new Workflow execution and get a handle for interacting with it:
|
|
45
43
|
* ```ts
|
|
46
|
-
* //
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
* await workflow.execute(2);
|
|
44
|
+
* // Start the Workflow with initialValue of 2.
|
|
45
|
+
* const handle = await startWorkflow(counterWorkflow, { args: [2] });
|
|
46
|
+
* await handle.signal(incrementSignal, 2);
|
|
47
|
+
* await handle.result(); // throws WorkflowExecutionTerminatedError
|
|
51
48
|
* ```
|
|
52
49
|
*/
|
|
53
50
|
export interface ChildWorkflowHandle<T extends Workflow> extends BaseWorkflowHandle<T> {
|
|
51
|
+
/**
|
|
52
|
+
* The runId of the initial run of the bound Workflow
|
|
53
|
+
*/
|
|
54
|
+
readonly originalRunId: string;
|
|
54
55
|
}
|
package/lib/workflow.d.ts
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
import { ActivityFunction, ActivityOptions, Workflow } from '@temporalio/common';
|
|
1
|
+
import { ActivityFunction, ActivityOptions, Workflow, WorkflowResultType, SignalDefinition, QueryDefinition, WithWorkflowArgs, WorkflowReturnType } from '@temporalio/common';
|
|
2
2
|
import { ChildWorkflowOptions, ChildWorkflowOptionsWithDefaults, ContinueAsNewOptions, WorkflowInfo } from './interfaces';
|
|
3
3
|
import { ExternalDependencies } from './dependencies';
|
|
4
4
|
import { ExternalWorkflowHandle, ChildWorkflowHandle } from './workflow-handle';
|
|
5
5
|
/**
|
|
6
6
|
* Adds default values to `workflowId` and `workflowIdReusePolicy` to given workflow options.
|
|
7
7
|
*/
|
|
8
|
-
export declare function addDefaultWorkflowOptions(opts: ChildWorkflowOptions): ChildWorkflowOptionsWithDefaults;
|
|
8
|
+
export declare function addDefaultWorkflowOptions<T extends Workflow>(opts: WithWorkflowArgs<T, ChildWorkflowOptions>): ChildWorkflowOptionsWithDefaults;
|
|
9
9
|
/**
|
|
10
10
|
* Asynchronous sleep.
|
|
11
11
|
*
|
|
12
12
|
* Schedules a timer on the Temporal service.
|
|
13
|
-
* The returned promise is {@link cancel | cancellable}.
|
|
14
13
|
*
|
|
15
|
-
* @param ms milliseconds to
|
|
14
|
+
* @param ms sleep duration - {@link https://www.npmjs.com/package/ms | ms} formatted string or number of milliseconds. If given a negative number, value will be set to 1.
|
|
15
|
+
*
|
|
16
16
|
*/
|
|
17
|
-
export declare function sleep(ms: number): Promise<void>;
|
|
17
|
+
export declare function sleep(ms: number | string): Promise<void>;
|
|
18
18
|
export interface ActivityInfo {
|
|
19
19
|
name: string;
|
|
20
20
|
type: string;
|
|
@@ -74,25 +74,99 @@ export declare function createActivityHandle<A extends Record<string, ActivityFu
|
|
|
74
74
|
* Returns a client-side handle that can be used to signal and cancel an existing Workflow execution.
|
|
75
75
|
* It takes a Workflow ID and optional run ID.
|
|
76
76
|
*/
|
|
77
|
-
export declare function
|
|
77
|
+
export declare function getExternalWorkflowHandle(workflowId: string, runId?: string): ExternalWorkflowHandle;
|
|
78
|
+
/**
|
|
79
|
+
* Start a child Workflow execution
|
|
80
|
+
*
|
|
81
|
+
* **Override for Workflows that accept no arguments**.
|
|
82
|
+
*
|
|
83
|
+
* - Returns a client-side handle that implements a child Workflow interface.
|
|
84
|
+
* - By default a child will be scheduled on the same task queue as its parent.
|
|
85
|
+
*
|
|
86
|
+
* A child Workflow handle supports awaiting completion, signaling and cancellation via {@link CancellationScope}s.
|
|
87
|
+
* In order to query the child, use a {@link WorkflowClient} from an Activity.
|
|
88
|
+
*/
|
|
89
|
+
export declare function startChild<T extends Workflow>(workflowType: string, options: ChildWorkflowOptions): Promise<ChildWorkflowHandle<T>>;
|
|
90
|
+
/**
|
|
91
|
+
* Start a child Workflow execution
|
|
92
|
+
*
|
|
93
|
+
* **Override for Workflows that accept no arguments**.
|
|
94
|
+
*
|
|
95
|
+
* - Returns a client-side handle that implements a child Workflow interface.
|
|
96
|
+
* - Deduces the Workflow type and signature from provided Workflow function.
|
|
97
|
+
* - By default a child will be scheduled on the same task queue as its parent.
|
|
98
|
+
*
|
|
99
|
+
* A child Workflow handle supports awaiting completion, signaling and cancellation via {@link CancellationScope}s.
|
|
100
|
+
* In order to query the child, use a {@link WorkflowClient} from an Activity.
|
|
101
|
+
*/
|
|
102
|
+
export declare function startChild<T extends Workflow>(workflowFunc: T, options: WithWorkflowArgs<T, ChildWorkflowOptions>): Promise<ChildWorkflowHandle<T>>;
|
|
103
|
+
/**
|
|
104
|
+
* Start a child Workflow execution
|
|
105
|
+
*
|
|
106
|
+
* **Override for Workflows that accept no arguments**.
|
|
107
|
+
*
|
|
108
|
+
* - Returns a client-side handle that implements a child Workflow interface.
|
|
109
|
+
* - The child will be scheduled on the same task queue as its parent.
|
|
110
|
+
*
|
|
111
|
+
* A child Workflow handle supports awaiting completion, signaling and cancellation via {@link CancellationScope}s.
|
|
112
|
+
* In order to query the child, use a {@link WorkflowClient} from an Activity.
|
|
113
|
+
*/
|
|
114
|
+
export declare function startChild<T extends () => Promise<any>>(workflowType: string): Promise<ChildWorkflowHandle<T>>;
|
|
115
|
+
/**
|
|
116
|
+
* Start a child Workflow execution
|
|
117
|
+
*
|
|
118
|
+
* **Override for Workflows that accept no arguments**.
|
|
119
|
+
*
|
|
120
|
+
* - Returns a client-side handle that implements a child Workflow interface.
|
|
121
|
+
* - Deduces the Workflow type and signature from provided Workflow function.
|
|
122
|
+
* - The child will be scheduled on the same task queue as its parent.
|
|
123
|
+
*
|
|
124
|
+
* A child Workflow handle supports awaiting completion, signaling and cancellation via {@link CancellationScope}s.
|
|
125
|
+
* In order to query the child, use a {@link WorkflowClient} from an Activity.
|
|
126
|
+
*/
|
|
127
|
+
export declare function startChild<T extends () => Promise<any>>(workflowFunc: T): Promise<ChildWorkflowHandle<T>>;
|
|
128
|
+
/**
|
|
129
|
+
* Start a child Workflow execution and await its completion.
|
|
130
|
+
*
|
|
131
|
+
* - By default a child will be scheduled on the same task queue as its parent.
|
|
132
|
+
* - This operation is cancellable using {@link CancellationScope}s.
|
|
133
|
+
*
|
|
134
|
+
* @return The result of the child Workflow.
|
|
135
|
+
*/
|
|
136
|
+
export declare function executeChild<T extends Workflow>(workflowType: string, options: WithWorkflowArgs<T, ChildWorkflowOptions>): Promise<WorkflowResultType<T>>;
|
|
137
|
+
/**
|
|
138
|
+
* Start a child Workflow execution and await its completion.
|
|
139
|
+
*
|
|
140
|
+
* - By default a child will be scheduled on the same task queue as its parent.
|
|
141
|
+
* - Deduces the Workflow type and signature from provided Workflow function.
|
|
142
|
+
* - This operation is cancellable using {@link CancellationScope}s.
|
|
143
|
+
*
|
|
144
|
+
* @return The result of the child Workflow.
|
|
145
|
+
*/
|
|
146
|
+
export declare function executeChild<T extends Workflow>(workflowType: T, options: WithWorkflowArgs<T, ChildWorkflowOptions>): Promise<WorkflowResultType<T>>;
|
|
78
147
|
/**
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
148
|
+
* Start a child Workflow execution and await its completion.
|
|
149
|
+
*
|
|
150
|
+
* **Override for Workflows that accept no arguments**.
|
|
151
|
+
*
|
|
152
|
+
* - The child will be scheduled on the same task queue as its parent.
|
|
153
|
+
* - This operation is cancellable using {@link CancellationScope}s.
|
|
82
154
|
*
|
|
83
|
-
*
|
|
84
|
-
* In order to query the child, use a WorkflowClient from an Activity.
|
|
155
|
+
* @return The result of the child Workflow.
|
|
85
156
|
*/
|
|
86
|
-
export declare function
|
|
157
|
+
export declare function executeChild<T extends () => WorkflowReturnType>(workflowType: string): Promise<WorkflowResultType<T>>;
|
|
87
158
|
/**
|
|
88
|
-
*
|
|
89
|
-
* Deduces the Workflow interface from provided Workflow function.
|
|
90
|
-
* Workflow options may be needed to override the timeouts and task queue if they differ from the parent Workflow.
|
|
159
|
+
* Start a child Workflow execution and await its completion.
|
|
91
160
|
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
161
|
+
* **Override for Workflows that accept no arguments**.
|
|
162
|
+
*
|
|
163
|
+
* - The child will be scheduled on the same task queue as its parent.
|
|
164
|
+
* - Deduces the Workflow type and signature from provided Workflow function.
|
|
165
|
+
* - This operation is cancellable using {@link CancellationScope}s.
|
|
166
|
+
*
|
|
167
|
+
* @return The result of the child Workflow.
|
|
94
168
|
*/
|
|
95
|
-
export declare function
|
|
169
|
+
export declare function executeChild<T extends () => WorkflowReturnType>(workflowFunc: T): Promise<ChildWorkflowHandle<T>>;
|
|
96
170
|
/**
|
|
97
171
|
* Get information about the current Workflow
|
|
98
172
|
*/
|
|
@@ -102,8 +176,14 @@ export declare function workflowInfo(): WorkflowInfo;
|
|
|
102
176
|
*
|
|
103
177
|
* @example
|
|
104
178
|
* ```ts
|
|
105
|
-
* import { dependencies } from '@temporalio/workflow';
|
|
106
|
-
*
|
|
179
|
+
* import { dependencies, ExternalDependencies } from '@temporalio/workflow';
|
|
180
|
+
*
|
|
181
|
+
* interface MyDependencies extends ExternalDependencies {
|
|
182
|
+
* logger: {
|
|
183
|
+
* info(message: string): void;
|
|
184
|
+
* error(message: string): void;
|
|
185
|
+
* };
|
|
186
|
+
* }
|
|
107
187
|
*
|
|
108
188
|
* const { logger } = dependencies<MyDependencies>();
|
|
109
189
|
* logger.info('setting up');
|
|
@@ -151,14 +231,14 @@ export declare function continueAsNew<F extends Workflow>(...args: Parameters<F>
|
|
|
151
231
|
/**
|
|
152
232
|
* Generate an RFC compliant V4 uuid.
|
|
153
233
|
* Uses the workflow's deterministic PRNG making it safe for use within a workflow.
|
|
154
|
-
* This function is
|
|
234
|
+
* This function is cryptographically insecure.
|
|
155
235
|
* See the {@link https://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid | stackoverflow discussion}.
|
|
156
236
|
*/
|
|
157
237
|
export declare function uuid4(): string;
|
|
158
238
|
/**
|
|
159
239
|
* Patch or upgrade workflow code by checking or stating that this workflow has a certain patch.
|
|
160
240
|
*
|
|
161
|
-
* See [docs page](https://docs.temporal.io/docs/
|
|
241
|
+
* See [docs page](https://docs.temporal.io/docs/typescript/versioning) for info.
|
|
162
242
|
*
|
|
163
243
|
* If the workflow is replaying an existing history, then this function returns true if that
|
|
164
244
|
* history was produced by a worker which also had a `patched` call with the same `patchId`.
|
|
@@ -176,7 +256,7 @@ export declare function patched(patchId: string): boolean;
|
|
|
176
256
|
/**
|
|
177
257
|
* Indicate that a patch is being phased out.
|
|
178
258
|
*
|
|
179
|
-
* See [docs page](https://docs.temporal.io/docs/
|
|
259
|
+
* See [docs page](https://docs.temporal.io/docs/typescript/versioning) for info.
|
|
180
260
|
*
|
|
181
261
|
* Workflows with this call may be deployed alongside workflows with a {@link patched} call, but
|
|
182
262
|
* they must *not* be deployed while any workers still exist running old code without a
|
|
@@ -191,3 +271,42 @@ export declare function patched(patchId: string): boolean;
|
|
|
191
271
|
* calls with the same ID, which means all such calls will always return the same value.
|
|
192
272
|
*/
|
|
193
273
|
export declare function deprecatePatch(patchId: string): void;
|
|
274
|
+
/**
|
|
275
|
+
* Returns a Promise that resolves when `fn` evaluates to `true` or `timeout` expires.
|
|
276
|
+
*
|
|
277
|
+
* @param timeout {@link https://www.npmjs.com/package/ms | ms} formatted string or number of milliseconds
|
|
278
|
+
*
|
|
279
|
+
* @returns a boolean indicating whether the condition was true before the timeout expires
|
|
280
|
+
*/
|
|
281
|
+
export declare function condition(timeout: number | string, fn: () => boolean): Promise<boolean>;
|
|
282
|
+
/**
|
|
283
|
+
* Returns a Promise that resolves when `fn` evaluates to `true`.
|
|
284
|
+
*/
|
|
285
|
+
export declare function condition(fn: () => boolean): Promise<void>;
|
|
286
|
+
/**
|
|
287
|
+
* Define a signal method for a Workflow.
|
|
288
|
+
*
|
|
289
|
+
* Definitions are used to register listeners in the Workflow via {@link setListener} and to signal Workflows using a {@link WorkflowHandle}, {@link ChildWorkflowHandle} or {@link ExternalWorkflowHandle}.
|
|
290
|
+
* Definitions can be reused in multiple Workflows.
|
|
291
|
+
*/
|
|
292
|
+
export declare function defineSignal<Args extends any[] = []>(name: string): SignalDefinition<Args>;
|
|
293
|
+
/**
|
|
294
|
+
* Define a query method for a Workflow.
|
|
295
|
+
*
|
|
296
|
+
* Definitions are used to register listeners in the Workflow via {@link setListener} and to query Workflows using a {@link WorkflowHandle}.
|
|
297
|
+
* Definitions can be reused in multiple Workflows.
|
|
298
|
+
*/
|
|
299
|
+
export declare function defineQuery<Ret, Args extends any[] = []>(name: string): QueryDefinition<Ret, Args>;
|
|
300
|
+
/**
|
|
301
|
+
* A listener function capable of accepting the arguments for a given SignalDefinition or QueryDefinition.
|
|
302
|
+
*/
|
|
303
|
+
export declare type Listener<Ret, Args extends any[], T extends SignalDefinition<Args> | QueryDefinition<Ret, Args>> = T extends SignalDefinition<infer A> ? (...args: A) => void | Promise<void> : T extends QueryDefinition<infer R, infer A> ? (...args: A) => R : never;
|
|
304
|
+
/**
|
|
305
|
+
* Set a listener function for a Workflow query or signal.
|
|
306
|
+
*
|
|
307
|
+
* If this function is called multiple times for a given signal or query name the last listener will overwrite any previous calls.
|
|
308
|
+
*
|
|
309
|
+
* @param def a {@link SignalDefinition} or {@link QueryDefinition} as returned by {@link defineSignal} or {@link defineQuery} respectively.
|
|
310
|
+
* @param listener a compatible listener function for the given definition.
|
|
311
|
+
*/
|
|
312
|
+
export declare function setListener<Ret, Args extends any[], T extends SignalDefinition<Args> | QueryDefinition<Ret, Args>>(def: T, listener: Listener<Ret, Args, T>): void;
|