Minor fixes to type definitions

- Document support for RxJS 4 and 5
- Accept `Stream` as a return value instead of `Readable`
- Remove dummy body in stream tests.
- Reword some comments.

Closes #41

README.md

@@ -67,9 +67,9 @@ Optionally takes a callback to call when async tasks are complete.
 * `Promise` returned
   - Completion: [onFulfilled][promise-onfulfilled] method called
   - Error: [onRejected][promise-onrejected] method called
-* `Observable` returned
-  - Completion: [onCompleted][observable-subscribe] method called
-  - Error: [onError][observable-subscribe] method called
+* `Observable` (e.g. from [RxJS v5][rxjs5-observable] or [RxJS v4][rxjs5-observable]) returned
+  - Completion: [complete][rxjs5-subscriber-complete] method called
+  - Error: [error][rxjs5-subscriber-error] method called
 
 __Warning:__ Sync tasks are __not supported__ and your function will never complete if the one of the above strategies is not used to signal completion. However, thrown errors will be caught by the domain.
 
@@ -96,7 +96,10 @@ MIT
 [event-stream]: https://github.com/dominictarr/event-stream
 [promise-onfulfilled]: http://promisesaplus.com/#point-26
 [promise-onrejected]: http://promisesaplus.com/#point-30
-[observable-subscribe]: https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/subscribe.md
+[rx4-observable]: https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/observable.md
+[rxjs5-observable]: http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html
+[rxjs5-observer-complete]: http://reactivex.io/rxjs/class/es6/MiscJSDoc.js~ObserverDoc.html#instance-method-complete
+[rxjs5-observer-error]: http://reactivex.io/rxjs/class/es6/MiscJSDoc.js~ObserverDoc.html#instance-method-error
 
 [downloads-image]: http://img.shields.io/npm/dm/async-done.svg
 [npm-url]: https://www.npmjs.com/package/async-done

index.d.ts

@@ -50,25 +50,25 @@
  */
 import { ChildProcess } from "child_process";
 import { EventEmitter } from "events";
-import { Readable as ReadableStream } from "stream";
+import { Stream } from "stream";
 
 declare namespace asyncDone {
 
   /**
    * Represents a callback function used to signal the completion of a
-   * task that does not return any completion value.
+   * task without any result value.
    */
   type VoidCallback = (err: Error | null) => void;
 
   /**
    * Represents a callback function used to signal the completion of a
-   * task that does return a single completion value.
+   * task with a single result value.
    */
   interface Callback<T> {
     (err: null, result: T): void;
 
-    // Set the type of `result` to `T` if you want to enforce stricter callback functions.
-    // (See comment above about risks of unsound type checking)
+    // Use `result?: T` or `result: undefined` to require the consumer to assert the existence of the result
+    // (even in case of success). See comment at the top of the file.
     (err: Error, result?: any): void;
   }
 
@@ -87,7 +87,7 @@ declare namespace asyncDone {
   export type AsyncTask<R = any> =
     ((done: VoidCallback) => void)
     | ((done: Callback<R>) => void)
-    | (() => ChildProcess | EventEmitter | Observable<R> | PromiseLike<R> | ReadableStream );
+    | (() => ChildProcess | EventEmitter | Observable<R> | PromiseLike<R> | Stream);
 }
 
 /**

test/observables.js

@@ -11,6 +11,7 @@ function success() {
 }
 
 function successValue() {
+  // This corresponds to `Observable.return(42);` in RxJS 4
   return Observable.of(42);
 }
 

test/types/streams.ts

@@ -1,30 +1,14 @@
 import asyncDone from "async-done";
 import { Readable, Stream } from "stream";
 
-function readableSuccess(): Readable {
-  return undefined as any;
-}
-
-function readableFail(): Readable {
-  return undefined as any;
-}
-
 function streamSuccess(): Stream {
-  return undefined as any;
+  return new Stream();
 }
 
 function streamFail(): Stream {
-  return undefined as any;
+  return new Stream();
 }
 
-asyncDone(readableSuccess, function (err: Error | null): void {
-  console.log("Done");
-});
-
-asyncDone(readableFail, function (err: Error | null): void {
-  console.log("Done");
-});
-
 asyncDone(streamSuccess, function (err: Error | null): void {
   console.log("Done");
 });