Skip to content

Commit edd1779

Browse files
committed
Add links to the non-spec feature docs
1 parent d6a771b commit edd1779

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
A TypeScript implementation of the [Amazon States Language specification](https://states-language.net/spec.html).
44

5-
This package lets you run AWS Step Functions locally, both in Node.js and in the browser!
5+
This package lets you run AWS Step Functions completely locally, both in Node.js and in the browser!
66

7-
## Table of Contents
7+
## Table of contents
88

99
- [Features](#features)
1010
- [Installation](#installation)
@@ -76,10 +76,10 @@ The constructor takes the following parameters:
7676
- `validationOptions?`: An object that specifies how the definition should be validated.
7777
- `checkPaths`: If set to `false`, won't validate JSONPaths.
7878
- `checkArn`: If set to `false`, won't validate ARN syntax in `Task` states.
79-
- `awsConfig?`: An object that specifies the AWS region and credentials to use when invoking a Lambda function in a `Task` state. If not set, the AWS config will be resolved based on the [credentials provider chain](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials-node.html) of the AWS SDK for JavaScript V3. You don't need to use this option if you have a [shared config/credentials file](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) (for example, if you have the [AWS CLI](https://aws.amazon.com/cli/) installed) or if you use a local override for all of your `Task` states.
79+
- `awsConfig?`: An object that specifies the [AWS region and credentials](/docs/feature-support.md#providing-aws-credentials-and-region-to-execute-lambda-functions-specified-in-task-states) to use when invoking a Lambda function in a `Task` state. If not set, the AWS config will be resolved based on the [credentials provider chain](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials-node.html) of the AWS SDK for JavaScript V3. You don't need to use this option if you have a [shared config/credentials file](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html) (for example, if you have the [AWS CLI](https://aws.amazon.com/cli/) installed) or if you use a local override for all of your `Task` states.
8080
- `region`: The AWS region where the Lambda functions are created.
8181
- `credentials`: An object that specifies which type of credentials to use.
82-
- `cognitoIdentityPool`: An object that specifies the Cognito Identity Pool to use for requesting credentials.
82+
- `cognitoIdentityPool`: An object that specifies the Cognito Identity Pool ID to use for requesting credentials.
8383
- `accessKeys`: An object that specifies the [Access Key ID and Secret Access Key](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html#sec-access-keys-and-secret-access-keys) to use as credentials.
8484

8585
The constructor will attempt to validate the definition by default, unless the `validationOptions` property is specified. If the definition is not valid, an error will be thrown.
@@ -111,7 +111,7 @@ const stateMachine = new StateMachine(machineDefinition, {
111111

112112
Runs the state machine with the given `input` parameter and returns an object with the following properties:
113113

114-
- `abort`: A function that takes no parameters and doesn't return any value. If called, aborts the execution and throws an `ExecutionAbortedError`, unless the `noThrowOnAbort` option is set.
114+
- `abort`: A function that takes no parameters and doesn't return any value. If called, [aborts the execution](/docs/feature-support.md#abort-a-running-execution) and throws an `ExecutionAbortedError`, unless the `noThrowOnAbort` option is set.
115115
- `result`: A `Promise` that resolves with the execution result once it finishes.
116116

117117
Each execution is independent of all others, meaning that you can concurrently call this method as many times as needed, without worrying about race conditions.
@@ -121,8 +121,8 @@ Each execution is independent of all others, meaning that you can concurrently c
121121
- `input`: The initial input to pass to the state machine. This can be any valid JSON value.
122122
- `options?`:
123123
- `overrides?`: An object to override the behavior of certain states:
124-
- `taskResourceLocalHandlers?`: Overrides the resource of the specified `Task` states to run a local function.
125-
- `waitTimeOverrides?`: Overrides the wait duration of the specified `Wait` states. The specifed override duration should be in milliseconds.
124+
- `taskResourceLocalHandlers?`: An [object that overrides](/docs/feature-support.md#task-state-resource-override) the resource of the specified `Task` states to run a local function.
125+
- `waitTimeOverrides?`: An [object that overrides](/docs/feature-support.md#wait-state-duration-override) the wait duration of the specified `Wait` states. The specifed override duration should be in milliseconds.
126126
- `noThrowOnAbort?`: If this option is set to `true`, aborting the execution will simply return `null` as result instead of throwing.
127127

128128
#### Basic example:

0 commit comments

Comments
 (0)