workflow-manager - npm Package Compare versions

Comparing version 0.15.1 to 0.16.0

index.d.ts

@@ -86,3 +86,3 @@ import { Logger } from "kayvee";
   
-  getWorkflowByID(workflowID: string, options?: RequestOptions, cb?: Callback<models.Workflow>): Promise<models.Workflow>
+  getWorkflowByID(params: models.GetWorkflowByIDParams, options?: RequestOptions, cb?: Callback<models.Workflow>): Promise<models.Workflow>
   
@@ -162,2 +162,7 @@ resumeWorkflowByID(params: models.ResumeWorkflowByIDParams, options?: RequestOptions, cb?: Callback<models.Workflow>): Promise<models.Workflow>
     
+    type GetWorkflowByIDParams = {
+  workflowID: string;
+  fetchHistory?: boolean;
+};
+    
     type GetWorkflowDefinitionByNameAndVersionParams = {
@@ -164,0 +169,0 @@ name: string;

package.json

 {
   "name": "workflow-manager",
-  "version": "0.15.1",
+  "version": "0.16.0",
   "description": "Orchestrator for AWS Step Functions",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -26,3 +26,3 @@ <a name="module_workflow-manager"></a>
             * [.CancelWorkflow(params, [options], [cb])](#module_workflow-manager--WorkflowManager+CancelWorkflow) ⇒ <code>Promise</code>
-            * [.getWorkflowByID(workflowID, [options], [cb])](#module_workflow-manager--WorkflowManager+getWorkflowByID) ⇒ <code>Promise</code>
+            * [.getWorkflowByID(params, [options], [cb])](#module_workflow-manager--WorkflowManager+getWorkflowByID) ⇒ <code>Promise</code>
             * [.resumeWorkflowByID(params, [options], [cb])](#module_workflow-manager--WorkflowManager+resumeWorkflowByID) ⇒ <code>Promise</code>
@@ -351,3 +351,3 @@ * [.resolveWorkflowByID(workflowID, [options], [cb])](#module_workflow-manager--WorkflowManager+resolveWorkflowByID) ⇒ <code>Promise</code>
 
-#### workflowManager.getWorkflowByID(workflowID, [options], [cb]) ⇒ <code>Promise</code>
+#### workflowManager.getWorkflowByID(params, [options], [cb]) ⇒ <code>Promise</code>
 **Kind**: instance method of [<code>WorkflowManager</code>](#exp_module_workflow-manager--WorkflowManager)  
@@ -362,3 +362,5 @@ **Fulfill**: <code>Object</code>
 | --- | --- | --- |
-| workflowID | <code>string</code> |  |
+| params | <code>Object</code> |  |
+| params.workflowID | <code>string</code> |  |
+| [params.fetchHistory] | <code>boolean</code> | When true, the execution history will be fetched from SFN along with the workflow summary |
 | [options] | <code>object</code> |  |
@@ -365,0 +367,0 @@ | [options.timeout] | <code>number</code> | A request specific timeout |

No alert changes

Improved metrics

Total package byte prevSize

113577

increased by0.44%

Lines of code

2386

increased by0.29%

Number of lines in readme file

508

increased by0.4%

No dependency changes