Skip to content

Commit d24c32f

Browse files
committed
feat: Redesign
BREAKING CHANGE: this is a breaking change Redesign the concurrency architecture for 3.0 following #16
1 parent 9ab97b6 commit d24c32f

1 file changed

Lines changed: 3 additions & 5 deletions

File tree

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,11 @@ const worker = new StepFunctionWorker({
4040

4141
Since version **3.0**, `concurrency` has been replaced by `poolConcurrency` and `taskConcurrency`.
4242

43-
* `poolConcurrency` is the maximum number of parallel getActivity, http request (see [`sdk.getActivity`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/StepFunctions.html#getActivityTask-property)) (default: `1`)
43+
see more information in https://github.com/piercus/step-function-worker/issues/16#issuecomment-486971866
4444

45-
Increase this to have a more responsive worker, decrease this to consume less http connections.
45+
* `poolConcurrency` is the maximum number of parallel getActivity, http request (see [`sdk.getActivity`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/StepFunctions.html#getActivityTask-property)) (default: `1`) Increase this to have a more responsive worker, decrease this to consume less http connections.
4646

47-
* `taskConcurrency` (`null` means Infinite)
48-
49-
It represent the maximum number of parallel tasks done by the worker (default: equals to `poolConcurrency`).
47+
* `taskConcurrency` (`null` means Infinite) represents the maximum number of parallel tasks done by the worker (default: equals to `poolConcurrency`).
5048

5149
Anyway, you should always have `poolConcurrency` <= `taskConcurrency`.
5250

0 commit comments

Comments
 (0)