aws-local-stepfunctions 0.3.2 → 0.4.0

package/README.md

@@ -1,6 +1,6 @@
 # AWS Local Step Functions
 
-A Node.js implementation of the [Amazon States Language specification](https://states-language.net/spec.html).
+A TypeScript implementation of the [Amazon States Language specification](https://states-language.net/spec.html).
 
 This package lets you run AWS Step Functions locally on your machine!
 
@@ -17,6 +17,7 @@ This package lets you run AWS Step Functions locally on your machine!
 - [API](#api)
   - [Constructor](#constructor-new-statemachinedefinition-validationoptions)
   - [StateMachine.run](#statemachineruninput-options)
+- [Examples](#examples)
 - [License](#license)
 
 ## Features
@@ -101,9 +102,7 @@ Each execution is independent of all others, meaning that you can concurrently c
     - `waitTimeOverrides`: Overrides the wait duration of the specified `Wait` states. The specifed override duration should be in milliseconds.
   - `noThrowOnAbort`: If this option is set to `true`, aborting the execution will simply return `null` as result instead of throwing.
 
-#### Examples
-
-##### Example without `options`:
+#### Basic example:
 
 ```js
 import { StateMachine } from 'aws-local-stepfunctions';
@@ -127,89 +126,23 @@ const result = await execution.result; // wait until the execution finishes to g
 console.log(result); // log the result of the execution
 ```
 
-##### Example with `options`:
-
-```js
-import { StateMachine } from 'aws-local-stepfunctions';
-
-const machineDefinition = {
-  StartAt: 'Hello World',
-  States: {
-    'Hello World': {
-      Type: 'Task',
-      Resource: 'arn:aws:lambda:us-east-1:123456789012:function:HelloWorld',
-      Next: 'AddNumbers',
-    },
-    AddNumbers: {
-      Type: 'Task',
-      Resource: 'arn:aws:lambda:us-east-1:123456789012:function:AddNumbers',
-      Next: 'Wait10Seconds',
-    },
-    Wait10Seconds: {
-      Type: 'Wait',
-      Seconds: 10,
-      End: true,
-    },
-  },
-};
+## Examples
 
-function addNumbersLocal(input) {
-  return input.num1 + input.num2;
-}
+You can check more examples and options usage in the [examples](/examples) directory.
 
-const stateMachine = new StateMachine(machineDefinition);
-const myInput = { value1: 'hello', value2: 123, value3: true };
-const execution = stateMachine.run(myInput, {
-  overrides: {
-    taskResourceLocalHandlers: {
-      AddNumbers: addNumbersLocal, // call the `addNumbersLocal` function instead of invoking the Lambda function specified for the `AddNumbers` state
-    },
-    waitTimeOverrides: {
-      Wait10Seconds: 500, // wait for 500 milliseconds instead of the 10 seconds specified in the `Wait10Seconds` state
-    },
-  },
-});
+To run the examples, clone the repo, install the dependencies and build the project:
 
-const result = await execution.result;
-console.log(result);
+```sh
+git clone https://github.com/nibble-4bits/aws-local-stepfunctions.git --depth 1
+cd aws-local-stepfunctions
+npm install
+npm run build
 ```
 
-##### Aborting an execution
-
-```js
-import { StateMachine, ExecutionAbortedError } from 'aws-local-stepfunctions';
-
-const machineDefinition = {
-  StartAt: 'Hello World',
-  States: {
-    'Hello World': {
-      Type: 'Task',
-      Resource: 'arn:aws:lambda:us-east-1:123456789012:function:HelloWorld',
-      End: true,
-    },
-  },
-};
+Then run whichever example you want:
 
-const stateMachine = new StateMachine(machineDefinition);
-const myInput = { value1: 'hello', value2: 123, value3: true };
-const execution = stateMachine.run(myInput);
-
-// abort the execution after 3 seconds
-setTimeout(() => {
-  execution.abort();
-}, 3000);
-
-try {
-  const result = await execution.result;
-  console.log(result);
-} catch (e) {
-  if (e instanceof ExecutionAbortedError) {
-    // since execution was aborted, type of error is `ExecutionAbortedError`
-    console.log('Execution was aborted');
-  } else {
-    console.error('Some other error', e);
-  }
-}
+```sh
+node examples/abort-execution.js
 ```
 
 ## License