Skip to content

Commit

Permalink
chore: remove Promise interop from README
Browse files Browse the repository at this point in the history
  • Loading branch information
lholmquist committed Apr 19, 2017
1 parent 3f5827a commit c1f3b1b
Showing 1 changed file with 0 additions and 14 deletions.
14 changes: 0 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,20 +218,6 @@ breaker.fire()
.catch(console.error);
```

### Promise Interoperability

The `Promise` implementation used in `opossum` is compliant with both the
ES6 `Promise` API as well as the `promises/A+` API. This means that it doesn't
matter what flavor of promise your API uses, `opossum` should work fine with
it. If you would like to control what `Promise` implementation used in
`opossum`, provide a `Promise` constructor function in your options when
you create the breaker. E.g.

```javascript
// Force opossum to use native JS promises
const breaker = circuitBreaker(readFile, { Promise: Promise });
```

### Hystrix Metrics

A Hystrix Stream is available for use with a Hystrix Dashboard using the `circuitBreaker.hystrixStats.getHystrixStream` method.
Expand Down

0 comments on commit c1f3b1b

Please sign in to comment.