diff --git a/CHANGELOG.md b/CHANGELOG.md index 233308ae..0b609cb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +### [4.2.4](https://github.com/nodeshift/opossum/compare/v4.2.3...v4.2.4) (2020-01-22) + + +### Bug Fixes + +* **circuit:** allow timeout option to be false ([#396](https://github.com/nodeshift/opossum/issues/396)) ([2453326](https://github.com/nodeshift/opossum/commit/2453326)), closes [#393](https://github.com/nodeshift/opossum/issues/393) + ### [4.2.3](https://github.com/nodeshift/opossum/compare/v4.2.2...v4.2.3) (2020-01-03) ### [4.2.2](https://github.com/nodeshift/opossum/compare/v4.2.1...v4.2.2) (2020-01-02) diff --git a/docs/index.html b/docs/index.html index 11bd6b96..bea43ef0 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - opossum 4.2.3 | Documentation + opossum 4.2.4 | Documentation @@ -15,7 +15,7 @@

opossum

-
4.2.3
+
4.2.4
opossum https://nodeshift.dev/opossum/ -Typngs: +Typings: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/opossum @@ -713,7 +713,10 @@

options.timeout Number The time in milliseconds that action should -be allowed to execute before timing out. Default 10000 (10 seconds) +be allowed to execute before timing out. Timeout can be disabled by setting +this to +false +. Default 10000 (10 seconds) @@ -1325,7 +1328,7 @@

-

Gets whether this cicruit is in the pendingClosed state

+

Gets whether this circuit is in the pendingClosed state

pendingClose
@@ -1950,7 +1953,7 @@

Any parameters in addition to `context will be passed to the circuit function.

-
call(context: any, rest: ...any): Promise<any>
+
call(context: any, rest: any): Promise<any>
@@ -1978,8 +1981,9 @@

- rest (...any) - + rest (any) + the arguments passed to the action +
diff --git a/docs/opossum.md b/docs/opossum.md index 6ba39705..4e0c0fd0 100644 --- a/docs/opossum.md +++ b/docs/opossum.md @@ -64,7 +64,8 @@ Constructs a [CircuitBreaker][1]. - `action` **[Function][51]** The action to fire for this [CircuitBreaker][1] - `options` **[Object][52]** Options for the [CircuitBreaker][1] - `options.timeout` **[Number][53]** The time in milliseconds that action should - be allowed to execute before timing out. Default 10000 (10 seconds) + be allowed to execute before timing out. Timeout can be disabled by setting + this to `false`. Default 10000 (10 seconds) - `options.maxFailures` **[Number][53]** (Deprecated) The number of times the circuit can fail before opening. Default 10. - `options.resetTimeout` **[Number][53]** The time in milliseconds to wait before @@ -158,7 +159,7 @@ Type: [String][54] ### pendingClose -Gets whether this cicruit is in the `pendingClosed` state +Gets whether this circuit is in the `pendingClosed` state Type: [Boolean][55] @@ -259,7 +260,7 @@ circuit function. #### Parameters - `context` **any** the `this` context used for function execution -- `rest` **...any** +- `rest` **any** the arguments passed to the action Returns **[Promise][58]<any>** promise resolves with the circuit function's return value on success or is rejected on failure of the action. diff --git a/package-lock.json b/package-lock.json index 70853e13..89f78d19 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "opossum", - "version": "4.2.3", + "version": "4.2.4", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index a2cf79c3..2602cd37 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "opossum", - "version": "4.2.3", + "version": "4.2.4", "author": "Red Hat, Inc.", "license": "Apache-2.0", "support": {