Skip to content

Commit

Permalink
docs: add link to docs page
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfbecker authored Aug 25, 2018
1 parent a034dc2 commit bcbabb6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This micro library provides that mechanism.
npm install abortable-rx
```

## Included
## Included <span style="float: right">📖 [Full API documentation](https://unpkg.com/abortable-rx/docs/)</span>

### Observable factories

Expand All @@ -50,6 +50,8 @@ npm install abortable-rx
- `mergeMap<T, R>(project: (value: T, index: number, abortSignal: AbortSignal) => ObservableInput<R>): OperatorFunction<T, R>`
Like RxJS `mergeMap`, but passes an AbortSignal that is aborted when the returned Observable is unsubscribed from.

📖 [Full API documentation](https://unpkg.com/abortable-rx/docs/)

## Handling AbortError

`forEach` and `toPromise` will reject the Promise with an `Error` if the signal is aborted.
Expand Down

0 comments on commit bcbabb6

Please sign in to comment.