chore(release): 4.2.4

nodeshift · Jan 22, 2020 · 4bb9db5 · 4bb9db5
1 parent 750cfd7
commit 4bb9db5
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 13 deletions.
diff --git 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
@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta charset='utf-8'>
-  <title>opossum 4.2.3 | Documentation</title>
+  <title>opossum 4.2.4 | Documentation</title>
   <meta name='description' content='A fail-fast circuit breaker for promises and callbacks'>
   <meta name='viewport' content='width=device-width,initial-scale=1'>
   <link href='assets/bass.css' rel='stylesheet'>
@@ -15,7 +15,7 @@
       <div id='split-left' class='overflow-auto fs0 height-viewport-100'>
         <div class='py1 px2'>
           <h3 class='mb0 no-anchor'>opossum</h3>
-          <div class='mb1'><code>4.2.3</code></div>
+          <div class='mb1'><code>4.2.4</code></div>
           <input
             placeholder='Filter'
             id='filter-input'
@@ -435,7 +435,7 @@ <h1>opossum <a href="https://circleci.com/gh/nodeshift/opossum/tree/master"><img
 <td><a href="https://nodeshift.dev/opossum/">https://nodeshift.dev/opossum/</a></td>
 </tr>
 <tr>
-<td>Typngs:</td>
+<td>Typings:</td>
 <td><a href="https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/opossum">https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/opossum</a></td>
 </tr>
 <tr>
@@ -713,7 +713,10 @@ <h3 class='fl m0' id='circuitbreaker'>
   <td class='break-word'><span class='code bold'>options.timeout</span> <code class='quiet'><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></code>
   </td>
   <td class='break-word'><span>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 
+<code>false</code>
+. Default 10000 (10 seconds)
 </span></td>
 </tr>
 
@@ -1325,7 +1328,7 @@ <h3 class='fl m0' id='circuitbreaker'>
 
 
 
-  <p>Gets whether this cicruit is in the <code>pendingClosed</code> state</p>
+  <p>Gets whether this circuit is in the <code>pendingClosed</code> state</p>
 
     <div class='pre p1 fill-light mt0'>pendingClose</div>
 
@@ -1950,7 +1953,7 @@ <h3 class='fl m0' id='circuitbreaker'>
 <p>Any parameters in addition to `context will be passed to the
 circuit function.</p>
 
-    <div class='pre p1 fill-light mt0'>call(context: any, rest: ...any): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&#x3C;any></div>
+    <div class='pre p1 fill-light mt0'>call(context: any, rest: any): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&#x3C;any></div>
 
 
 
@@ -1978,8 +1981,9 @@ <h3 class='fl m0' id='circuitbreaker'>
 
         <div class='space-bottom0'>
           <div>
-            <span class='code bold'>rest</span> <code class='quiet'>(...any)</code>
-
+            <span class='code bold'>rest</span> <code class='quiet'>(any)</code>
+	    the arguments passed to the action
+
           </div>
 
         </div>

diff --git 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]&lt;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
diff --git 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": {