Skip to content

Commit

Permalink
Docs: Review and improve a little
Browse files Browse the repository at this point in the history
  • Loading branch information
phated committed Aug 4, 2017
1 parent 204de69 commit cd26d63
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Allows libraries to handle various caller provided asynchronous functions uniformly. Maps promises, observables, child processes and streams, and callbacks to callback style.

As async conventions evolve, it is useful to be able to deal with several different *styles* of async completion uniformly. With this module you can handle completion using a Node.js style completion callback, regardless even if supplied with a object that's a promise, observable, child process and/or stream.
As async conventions evolve, it is useful to be able to deal with several different *styles* of async completion uniformly. With this module you can handle completion using a node-style callback, regardless of a return value that's a promise, observable, child process or stream.

## Usage

Expand Down Expand Up @@ -75,7 +75,7 @@ __Warning:__ Sync tasks are __not supported__ and your function will never compl

#### `callback(error, result)`

If an error doesn't occur in the execution of the `fn` function, the `callback` method will receive the results as its second argument. Note: Observable and some streams don't received any results.
If an error doesn't occur in the execution of the `fn` function, the `callback` method will receive the results as its second argument. Note: Some streams don't received any results.

If an error occurred in the execution of the `fn` function, The `callback` method will receive an error as its first argument.

Expand All @@ -84,7 +84,7 @@ Errors can be caused by:
* A thrown error
* An error passed to a `done` callback
* An `error` event emitted on a returned `Stream`, `EventEmitter` or `Child Process`
* A rejection of a returned `Promise`
* A rejection of a returned `Promise` - If the `Promise` is not rejected with a value, we generate a new `Error`
* The `onError` handler being called on an `Observable`

## License
Expand Down

0 comments on commit cd26d63

Please sign in to comment.