workflow-manager
Advanced tools
workflow-manager - npm Package Compare versions
Comparing version 0.11.4 to 0.12.0
291
index.d.ts
@@ -22,2 +22,3 @@ import { Span, Tracer } from "opentracing"; | ||
| forEach(f: (r: R) => void, cb?: Callback<void>): Promise<void>; | ||
| forEachAsync(f: (r: R) => void, cb?: Callback<void>): Promise<void>; | ||
| } | ||
@@ -53,39 +54,123 @@ | ||
| type WorkflowManagerOptions = (DiscoveryOptions | AddressOptions) & GenericOptions; | ||
| type WorkflowManagerOptions = (DiscoveryOptions | AddressOptions) & GenericOptions; | ||
| import models = WorkflowManager.Models | ||
| type CancelReason = { | ||
| declare class WorkflowManager { | ||
| constructor(options: WorkflowManagerOptions); | ||
| healthCheck(options?: RequestOptions, cb?: Callback<void>): Promise<void> | ||
| postStateResource(NewStateResource?: models.NewStateResource, options?: RequestOptions, cb?: Callback<models.StateResource>): Promise<models.StateResource> | ||
| deleteStateResource(params: models.DeleteStateResourceParams, options?: RequestOptions, cb?: Callback<void>): Promise<void> | ||
| getStateResource(params: models.GetStateResourceParams, options?: RequestOptions, cb?: Callback<models.StateResource>): Promise<models.StateResource> | ||
| putStateResource(params: models.PutStateResourceParams, options?: RequestOptions, cb?: Callback<models.StateResource>): Promise<models.StateResource> | ||
| getWorkflowDefinitions(options?: RequestOptions, cb?: Callback<models.WorkflowDefinition[]>): Promise<models.WorkflowDefinition[]> | ||
| newWorkflowDefinition(NewWorkflowDefinitionRequest?: models.NewWorkflowDefinitionRequest, options?: RequestOptions, cb?: Callback<models.WorkflowDefinition>): Promise<models.WorkflowDefinition> | ||
| getWorkflowDefinitionVersionsByName(params: models.GetWorkflowDefinitionVersionsByNameParams, options?: RequestOptions, cb?: Callback<models.WorkflowDefinition[]>): Promise<models.WorkflowDefinition[]> | ||
| updateWorkflowDefinition(params: models.UpdateWorkflowDefinitionParams, options?: RequestOptions, cb?: Callback<models.WorkflowDefinition>): Promise<models.WorkflowDefinition> | ||
| getWorkflowDefinitionByNameAndVersion(params: models.GetWorkflowDefinitionByNameAndVersionParams, options?: RequestOptions, cb?: Callback<models.WorkflowDefinition>): Promise<models.WorkflowDefinition> | ||
| getWorkflows(params: models.GetWorkflowsParams, options?: RequestOptions, cb?: Callback<models.Workflow[]>): Promise<models.Workflow[]> | ||
| getWorkflowsIter(params: models.GetWorkflowsParams, options?: RequestOptions): IterResult<ArrayInner<models.Workflow[]>> | ||
| startWorkflow(StartWorkflowRequest?: models.StartWorkflowRequest, options?: RequestOptions, cb?: Callback<models.Workflow>): Promise<models.Workflow> | ||
| CancelWorkflow(params: models.CancelWorkflowParams, options?: RequestOptions, cb?: Callback<void>): Promise<void> | ||
| getWorkflowByID(workflowID: string, options?: RequestOptions, cb?: Callback<models.Workflow>): Promise<models.Workflow> | ||
| resumeWorkflowByID(params: models.ResumeWorkflowByIDParams, options?: RequestOptions, cb?: Callback<models.Workflow>): Promise<models.Workflow> | ||
| resolveWorkflowByID(workflowID: string, options?: RequestOptions, cb?: Callback<void>): Promise<void> | ||
| } | ||
| declare namespace WorkflowManager { | ||
| const RetryPolicies: { | ||
| Single: RetryPolicy; | ||
| Exponential: RetryPolicy; | ||
| None: RetryPolicy; | ||
| } | ||
| const DefaultCircuitOptions: CircuitOptions; | ||
| namespace Errors { | ||
| interface ErrorBody { | ||
| message: string; | ||
| [key: string]: any; | ||
| } | ||
| class BadRequest { | ||
| message?: string; | ||
| constructor(body: ErrorBody); | ||
| } | ||
| class InternalError { | ||
| message?: string; | ||
| constructor(body: ErrorBody); | ||
| } | ||
| class NotFound { | ||
| message?: string; | ||
| constructor(body: ErrorBody); | ||
| } | ||
| class Conflict { | ||
| message?: string; | ||
| constructor(body: ErrorBody); | ||
| } | ||
| } | ||
| namespace Models { | ||
| type CancelReason = { | ||
| reason?: string; | ||
| }; | ||
| type CancelWorkflowParams = { | ||
| type CancelWorkflowParams = { | ||
| workflowID: string; | ||
| reason: CancelReason; | ||
| }; | ||
| type Conflict = { | ||
| type Conflict = { | ||
| message?: string; | ||
| }; | ||
| type DeleteStateResourceParams = { | ||
| type DeleteStateResourceParams = { | ||
| namespace: string; | ||
| name: string; | ||
| }; | ||
| type GetStateResourceParams = { | ||
| type GetStateResourceParams = { | ||
| namespace: string; | ||
| name: string; | ||
| }; | ||
| type GetWorkflowDefinitionByNameAndVersionParams = { | ||
| type GetWorkflowDefinitionByNameAndVersionParams = { | ||
| name: string; | ||
| version: number; | ||
| }; | ||
| type GetWorkflowDefinitionVersionsByNameParams = { | ||
| type GetWorkflowDefinitionVersionsByNameParams = { | ||
| name: string; | ||
| latest?: boolean; | ||
| }; | ||
| type GetWorkflowsParams = { | ||
| type GetWorkflowsParams = { | ||
| limit?: number; | ||
@@ -99,4 +184,4 @@ oldestFirst?: boolean; | ||
| }; | ||
| type Job = { | ||
| type Job = { | ||
| attempts?: JobAttempt[]; | ||
@@ -117,4 +202,4 @@ container?: string; | ||
| }; | ||
| type JobAttempt = { | ||
| type JobAttempt = { | ||
| containerInstanceARN?: string; | ||
@@ -128,8 +213,8 @@ createdAt?: string; | ||
| }; | ||
| type JobStatus = ("created" | "queued" | "waiting_for_deps" | "running" | "succeeded" | "failed" | "aborted_deps_failed" | "aborted_by_user"); | ||
| type Manager = ("step-functions"); | ||
| type NewStateResource = { | ||
| type JobStatus = ("created" | "queued" | "waiting_for_deps" | "running" | "succeeded" | "failed" | "aborted_deps_failed" | "aborted_by_user"); | ||
| type Manager = ("step-functions"); | ||
| type NewStateResource = { | ||
| name?: string; | ||
@@ -139,4 +224,4 @@ namespace?: string; | ||
| }; | ||
| type NewWorkflowDefinitionRequest = { | ||
| type NewWorkflowDefinitionRequest = { | ||
| defaultTags?: { [key: string]: { | ||
@@ -150,4 +235,4 @@ | ||
| }; | ||
| type PutStateResourceParams = { | ||
| type PutStateResourceParams = { | ||
| namespace: string; | ||
@@ -157,14 +242,14 @@ name: string; | ||
| }; | ||
| type ResolvedByUserWrapper = { | ||
| type ResolvedByUserWrapper = { | ||
| isSet?: boolean; | ||
| value?: boolean; | ||
| }; | ||
| type ResumeWorkflowByIDParams = { | ||
| type ResumeWorkflowByIDParams = { | ||
| workflowID: string; | ||
| overrides: WorkflowDefinitionOverrides; | ||
| }; | ||
| type SLCatcher = { | ||
| type SLCatcher = { | ||
| ErrorEquals?: SLErrorEquals[]; | ||
@@ -174,4 +259,4 @@ Next?: string; | ||
| }; | ||
| type SLChoice = { | ||
| type SLChoice = { | ||
| And?: SLChoice[]; | ||
@@ -199,6 +284,6 @@ BooleanEquals?: boolean; | ||
| }; | ||
| type SLErrorEquals = string; | ||
| type SLRetrier = { | ||
| type SLErrorEquals = string; | ||
| type SLRetrier = { | ||
| BackoffRate?: number; | ||
@@ -209,4 +294,4 @@ ErrorEquals?: SLErrorEquals[]; | ||
| }; | ||
| type SLState = { | ||
| type SLState = { | ||
| Branches?: SLStateMachine[]; | ||
@@ -235,4 +320,4 @@ Catch?: SLCatcher[]; | ||
| }; | ||
| type SLStateMachine = { | ||
| type SLStateMachine = { | ||
| Comment?: string; | ||
@@ -244,6 +329,6 @@ StartAt?: string; | ||
| }; | ||
| type SLStateType = ("Pass" | "Task" | "Choice" | "Wait" | "Succeed" | "Fail" | "Parallel"); | ||
| type StartWorkflowRequest = { | ||
| type SLStateType = ("Pass" | "Task" | "Choice" | "Wait" | "Succeed" | "Fail" | "Parallel"); | ||
| type StartWorkflowRequest = { | ||
| idSuffix?: string; | ||
@@ -258,4 +343,4 @@ input?: string; | ||
| }; | ||
| type StateResource = { | ||
| type StateResource = { | ||
| lastUpdated?: string; | ||
@@ -267,13 +352,13 @@ name?: string; | ||
| }; | ||
| type StateResourceType = ("JobDefinitionARN" | "ActivityARN" | "LambdaFunctionARN"); | ||
| type UpdateWorkflowDefinitionParams = { | ||
| type StateResourceType = ("JobDefinitionARN" | "ActivityARN" | "LambdaFunctionARN"); | ||
| type UpdateWorkflowDefinitionParams = { | ||
| NewWorkflowDefinitionRequest?: NewWorkflowDefinitionRequest; | ||
| name: string; | ||
| }; | ||
| type Workflow = any; | ||
| type WorkflowDefinition = { | ||
| type Workflow = any; | ||
| type WorkflowDefinition = { | ||
| createdAt?: string; | ||
@@ -289,13 +374,13 @@ defaultTags?: { [key: string]: { | ||
| }; | ||
| type WorkflowDefinitionOverrides = { | ||
| type WorkflowDefinitionOverrides = { | ||
| StartAt?: string; | ||
| }; | ||
| type WorkflowDefinitionRef = { | ||
| type WorkflowDefinitionRef = { | ||
| name?: string; | ||
| version?: number; | ||
| }; | ||
| type WorkflowQuery = { | ||
| type WorkflowQuery = { | ||
| limit?: number; | ||
@@ -309,6 +394,6 @@ oldestFirst?: boolean; | ||
| }; | ||
| type WorkflowStatus = ("queued" | "running" | "failed" | "succeeded" | "cancelled"); | ||
| type WorkflowSummary = { | ||
| type WorkflowStatus = ("queued" | "running" | "failed" | "succeeded" | "cancelled"); | ||
| type WorkflowSummary = { | ||
| createdAt?: string; | ||
@@ -331,69 +416,3 @@ id?: string; | ||
| }; | ||
| declare class WorkflowManager { | ||
| constructor(options: WorkflowManagerOptions); | ||
| healthCheck(options?: RequestOptions, cb?: Callback<void>): Promise<void> | ||
| postStateResource(NewStateResource?: NewStateResource, options?: RequestOptions, cb?: Callback<StateResource>): Promise<StateResource> | ||
| deleteStateResource(params: DeleteStateResourceParams, options?: RequestOptions, cb?: Callback<void>): Promise<void> | ||
| getStateResource(params: GetStateResourceParams, options?: RequestOptions, cb?: Callback<StateResource>): Promise<StateResource> | ||
| putStateResource(params: PutStateResourceParams, options?: RequestOptions, cb?: Callback<StateResource>): Promise<StateResource> | ||
| getWorkflowDefinitions(options?: RequestOptions, cb?: Callback<WorkflowDefinition[]>): Promise<WorkflowDefinition[]> | ||
| newWorkflowDefinition(NewWorkflowDefinitionRequest?: NewWorkflowDefinitionRequest, options?: RequestOptions, cb?: Callback<WorkflowDefinition>): Promise<WorkflowDefinition> | ||
| getWorkflowDefinitionVersionsByName(params: GetWorkflowDefinitionVersionsByNameParams, options?: RequestOptions, cb?: Callback<WorkflowDefinition[]>): Promise<WorkflowDefinition[]> | ||
| updateWorkflowDefinition(params: UpdateWorkflowDefinitionParams, options?: RequestOptions, cb?: Callback<WorkflowDefinition>): Promise<WorkflowDefinition> | ||
| getWorkflowDefinitionByNameAndVersion(params: GetWorkflowDefinitionByNameAndVersionParams, options?: RequestOptions, cb?: Callback<WorkflowDefinition>): Promise<WorkflowDefinition> | ||
| getWorkflows(params: GetWorkflowsParams, options?: RequestOptions, cb?: Callback<Workflow[]>): Promise<Workflow[]> | ||
| getWorkflowsIter(params: GetWorkflowsParams, options?: RequestOptions): IterResult<ArrayInner<Workflow[]>> | ||
| startWorkflow(StartWorkflowRequest?: StartWorkflowRequest, options?: RequestOptions, cb?: Callback<Workflow>): Promise<Workflow> | ||
| CancelWorkflow(params: CancelWorkflowParams, options?: RequestOptions, cb?: Callback<void>): Promise<void> | ||
| getWorkflowByID(workflowID: string, options?: RequestOptions, cb?: Callback<Workflow>): Promise<Workflow> | ||
| resumeWorkflowByID(params: ResumeWorkflowByIDParams, options?: RequestOptions, cb?: Callback<Workflow>): Promise<Workflow> | ||
| resolveWorkflowByID(workflowID: string, options?: RequestOptions, cb?: Callback<void>): Promise<void> | ||
| } | ||
| declare namespace WorkflowManager { | ||
| const RetryPolicies: { | ||
| Single: RetryPolicy; | ||
| Exponential: RetryPolicy; | ||
| None: RetryPolicy; | ||
| } | ||
| const DefaultCircuitOptions: CircuitOptions; | ||
| namespace Errors { | ||
| class BadRequest { | ||
| message?: string; | ||
| } | ||
| class InternalError { | ||
| message?: string; | ||
| } | ||
| class NotFound { | ||
| message?: string; | ||
| } | ||
| class Conflict { | ||
| message?: string; | ||
| } | ||
| } | ||
@@ -400,0 +419,0 @@ } |
| { | ||
| "name": "workflow-manager", | ||
| "version": "0.11.4", | ||
| "version": "0.12.0", | ||
| "description": "Orchestrator for AWS Step Functions", | ||
@@ -11,3 +11,3 @@ "main": "index.js", | ||
| "request": "^2.87.0", | ||
| "kayvee": "^3.8.2", | ||
| "kayvee": "^3.13.0", | ||
| "hystrixjs": "^0.2.0", | ||
@@ -14,0 +14,0 @@ "rxjs": "^5.4.1" |
228
README.md
@@ -22,3 +22,3 @@ <a name="module_workflow-manager"></a> | ||
| * [.getWorkflows(params, [options], [cb])](#module_workflow-manager--WorkflowManager+getWorkflows) ⇒ <code>Promise</code> | ||
| * [.getWorkflowsIter(params, [options])](#module_workflow-manager--WorkflowManager+getWorkflowsIter) ⇒ <code>Object</code> | <code>function</code> | <code>function</code> | <code>function</code> | ||
| * [.getWorkflowsIter(params, [options])](#module_workflow-manager--WorkflowManager+getWorkflowsIter) ⇒ <code>Object</code> \| <code>function</code> \| <code>function</code> \| <code>function</code> \| <code>function</code> | ||
| * [.startWorkflow(StartWorkflowRequest, [options], [cb])](#module_workflow-manager--WorkflowManager+startWorkflow) ⇒ <code>Promise</code> | ||
@@ -59,4 +59,4 @@ * [.CancelWorkflow(params, [options], [cb])](#module_workflow-manager--WorkflowManager+CancelWorkflow) ⇒ <code>Promise</code> | ||
| | [options.timeout] | <code>number</code> | | The timeout to use for all client requests, in milliseconds. This can be overridden on a per-request basis. Default is 5000ms. | | ||
| | [options.keepalive] | <code>bool</code> | | Set keepalive to true for client requests. This sets the forever: true attribute in request. Defaults to false | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | <code>RetryPolicies.Single</code> | The logic to determine which requests to retry, as well as how many times to retry. | | ||
| | [options.keepalive] | <code>bool</code> | | Set keepalive to true for client requests. This sets the forever: true attribute in request. Defaults to true. | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | <code>RetryPolicies.Single</code> | The logic to determine which requests to retry, as well as how many times to retry. | | ||
| | [options.logger] | <code>module:kayvee.Logger</code> | <code>logger.New("workflow-manager-wagclient")</code> | The Kayvee logger to use in the client. | | ||
@@ -75,6 +75,6 @@ | [options.circuit] | <code>Object</code> | | Options for constructing the client's circuit breaker. | | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>undefined</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -86,4 +86,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -94,6 +94,6 @@ | ||
| #### workflowManager.postStateResource(NewStateResource, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -106,4 +106,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -114,7 +114,7 @@ | ||
| #### workflowManager.deleteStateResource(params, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>undefined</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[NotFound](#module_workflow-manager--WorkflowManager.Errors.NotFound)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>NotFound</code>](#module_workflow-manager--WorkflowManager.Errors.NotFound) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -129,4 +129,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -137,7 +137,7 @@ | ||
| #### workflowManager.getStateResource(params, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[NotFound](#module_workflow-manager--WorkflowManager.Errors.NotFound)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>NotFound</code>](#module_workflow-manager--WorkflowManager.Errors.NotFound) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -152,4 +152,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -160,6 +160,6 @@ | ||
| #### workflowManager.putStateResource(params, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -175,4 +175,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -185,6 +185,6 @@ | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object[]</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -196,4 +196,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -204,6 +204,6 @@ | ||
| #### workflowManager.newWorkflowDefinition(NewWorkflowDefinitionRequest, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -216,4 +216,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -224,7 +224,7 @@ | ||
| #### workflowManager.getWorkflowDefinitionVersionsByName(params, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object[]</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[NotFound](#module_workflow-manager--WorkflowManager.Errors.NotFound)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>NotFound</code>](#module_workflow-manager--WorkflowManager.Errors.NotFound) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -239,4 +239,4 @@ | ||
| | [options.timeout] | <code>number</code> | | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | | ||
@@ -247,7 +247,7 @@ | ||
| #### workflowManager.updateWorkflowDefinition(params, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[NotFound](#module_workflow-manager--WorkflowManager.Errors.NotFound)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>NotFound</code>](#module_workflow-manager--WorkflowManager.Errors.NotFound) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -262,4 +262,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -270,7 +270,7 @@ | ||
| #### workflowManager.getWorkflowDefinitionByNameAndVersion(params, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[NotFound](#module_workflow-manager--WorkflowManager.Errors.NotFound)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>NotFound</code>](#module_workflow-manager--WorkflowManager.Errors.NotFound) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -285,4 +285,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -293,7 +293,7 @@ | ||
| #### workflowManager.getWorkflows(params, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object[]</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[NotFound](#module_workflow-manager--WorkflowManager.Errors.NotFound)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>NotFound</code>](#module_workflow-manager--WorkflowManager.Errors.NotFound) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -313,4 +313,4 @@ | ||
| | [options.timeout] | <code>number</code> | | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | | ||
@@ -320,5 +320,5 @@ | ||
| #### workflowManager.getWorkflowsIter(params, [options]) ⇒ <code>Object</code> | <code>function</code> | <code>function</code> | <code>function</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Returns**: <code>Object</code> - iter<code>function</code> - iter.map - takes in a function, applies it to each resource, and returns a promise to the result as an array<code>function</code> - iter.toArray - returns a promise to the resources as an array<code>function</code> - iter.forEach - takes in a function, applies it to each resource | ||
| #### workflowManager.getWorkflowsIter(params, [options]) ⇒ <code>Object</code> \| <code>function</code> \| <code>function</code> \| <code>function</code> \| <code>function</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Returns**: <code>Object</code> - iter<code>function</code> - iter.map - takes in a function, applies it to each resource, and returns a promise to the result as an array<code>function</code> - iter.toArray - returns a promise to the resources as an array<code>function</code> - iter.forEach - takes in a function, applies it to each resource<code>function</code> - iter.forEachAsync - takes in an async function, applies it to each resource | ||
@@ -337,4 +337,4 @@ | Param | Type | Default | Description | | ||
| | [options.timeout] | <code>number</code> | | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | | A request specific retryPolicy | | ||
@@ -344,7 +344,7 @@ <a name="module_workflow-manager--WorkflowManager+startWorkflow"></a> | ||
| #### workflowManager.startWorkflow(StartWorkflowRequest, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[NotFound](#module_workflow-manager--WorkflowManager.Errors.NotFound)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>NotFound</code>](#module_workflow-manager--WorkflowManager.Errors.NotFound) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -357,4 +357,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -365,7 +365,7 @@ | ||
| #### workflowManager.CancelWorkflow(params, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>undefined</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[NotFound](#module_workflow-manager--WorkflowManager.Errors.NotFound)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>NotFound</code>](#module_workflow-manager--WorkflowManager.Errors.NotFound) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -380,4 +380,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -388,7 +388,7 @@ | ||
| #### workflowManager.getWorkflowByID(workflowID, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[NotFound](#module_workflow-manager--WorkflowManager.Errors.NotFound)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>NotFound</code>](#module_workflow-manager--WorkflowManager.Errors.NotFound) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -401,4 +401,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -409,7 +409,7 @@ | ||
| #### workflowManager.resumeWorkflowByID(params, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>Object</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[NotFound](#module_workflow-manager--WorkflowManager.Errors.NotFound)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>NotFound</code>](#module_workflow-manager--WorkflowManager.Errors.NotFound) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -424,4 +424,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -432,8 +432,8 @@ | ||
| #### workflowManager.resolveWorkflowByID(workflowID, [options], [cb]) ⇒ <code>Promise</code> | ||
| **Kind**: instance method of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
| **Fulfill**: <code>undefined</code> | ||
| **Reject**: <code>[BadRequest](#module_workflow-manager--WorkflowManager.Errors.BadRequest)</code> | ||
| **Reject**: <code>[NotFound](#module_workflow-manager--WorkflowManager.Errors.NotFound)</code> | ||
| **Reject**: <code>[Conflict](#module_workflow-manager--WorkflowManager.Errors.Conflict)</code> | ||
| **Reject**: <code>[InternalError](#module_workflow-manager--WorkflowManager.Errors.InternalError)</code> | ||
| **Reject**: [<code>BadRequest</code>](#module_workflow-manager--WorkflowManager.Errors.BadRequest) | ||
| **Reject**: [<code>NotFound</code>](#module_workflow-manager--WorkflowManager.Errors.NotFound) | ||
| **Reject**: [<code>Conflict</code>](#module_workflow-manager--WorkflowManager.Errors.Conflict) | ||
| **Reject**: [<code>InternalError</code>](#module_workflow-manager--WorkflowManager.Errors.InternalError) | ||
| **Reject**: <code>Error</code> | ||
@@ -446,4 +446,4 @@ | ||
| | [options.timeout] | <code>number</code> | A request specific timeout | | ||
| | [options.span] | <code>[Span](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html)</code> | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | A request specific retryPolicy | | ||
| | [options.span] | [<code>Span</code>](https://doc.esdoc.org/github.com/opentracing/opentracing-javascript/class/src/span.js~Span.html) | An OpenTracing span - For example from the parent request | | ||
| | [options.retryPolicy] | [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | A request specific retryPolicy | | ||
| | [cb] | <code>function</code> | | | ||
@@ -456,3 +456,3 @@ | ||
| **Kind**: static property of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: static property of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
@@ -469,3 +469,3 @@ * [.RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies) | ||
| **Kind**: static constant of <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | ||
| **Kind**: static constant of [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | ||
| <a name="module_workflow-manager--WorkflowManager.RetryPolicies.Single"></a> | ||
@@ -476,3 +476,3 @@ | ||
| **Kind**: static constant of <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | ||
| **Kind**: static constant of [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | ||
| <a name="module_workflow-manager--WorkflowManager.RetryPolicies.None"></a> | ||
@@ -483,3 +483,3 @@ | ||
| **Kind**: static constant of <code>[RetryPolicies](#module_workflow-manager--WorkflowManager.RetryPolicies)</code> | ||
| **Kind**: static constant of [<code>RetryPolicies</code>](#module_workflow-manager--WorkflowManager.RetryPolicies) | ||
| <a name="module_workflow-manager--WorkflowManager.Errors"></a> | ||
@@ -490,3 +490,3 @@ | ||
| **Kind**: static property of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: static property of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) | ||
@@ -504,4 +504,4 @@ * [.Errors](#module_workflow-manager--WorkflowManager.Errors) | ||
| **Kind**: static class of <code>[Errors](#module_workflow-manager--WorkflowManager.Errors)</code> | ||
| **Extends:** <code>Error</code> | ||
| **Kind**: static class of [<code>Errors</code>](#module_workflow-manager--WorkflowManager.Errors) | ||
| **Extends**: <code>Error</code> | ||
| **Properties** | ||
@@ -518,4 +518,4 @@ | ||
| **Kind**: static class of <code>[Errors](#module_workflow-manager--WorkflowManager.Errors)</code> | ||
| **Extends:** <code>Error</code> | ||
| **Kind**: static class of [<code>Errors</code>](#module_workflow-manager--WorkflowManager.Errors) | ||
| **Extends**: <code>Error</code> | ||
| **Properties** | ||
@@ -532,4 +532,4 @@ | ||
| **Kind**: static class of <code>[Errors](#module_workflow-manager--WorkflowManager.Errors)</code> | ||
| **Extends:** <code>Error</code> | ||
| **Kind**: static class of [<code>Errors</code>](#module_workflow-manager--WorkflowManager.Errors) | ||
| **Extends**: <code>Error</code> | ||
| **Properties** | ||
@@ -546,4 +546,4 @@ | ||
| **Kind**: static class of <code>[Errors](#module_workflow-manager--WorkflowManager.Errors)</code> | ||
| **Extends:** <code>Error</code> | ||
| **Kind**: static class of [<code>Errors</code>](#module_workflow-manager--WorkflowManager.Errors) | ||
| **Extends**: <code>Error</code> | ||
| **Properties** | ||
@@ -560,2 +560,2 @@ | ||
| **Kind**: static constant of <code>[WorkflowManager](#exp_module_workflow-manager--WorkflowManager)</code> | ||
| **Kind**: static constant of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager) |
Sorry, the diff of this file is too big to display
No alert changes
Improved metrics
- Total package byte prevSize
- increased by2.96%
125189
- Lines of code
- increased by3.23%
2526
Dependency changes
Updatedkayvee@^3.13.0