Skip to content

Commit cd26d63

Browse files
committed
Docs: Review and improve a little
1 parent 204de69 commit cd26d63

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

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

13-
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.
13+
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.
1414

1515
## Usage
1616

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

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

78-
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.
78+
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.
7979

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

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

9090
## License

0 commit comments

Comments
 (0)