Add type definitions for RxJS bindings for Node

rx-node/rx.node-tests.ts

@@ -0,0 +1,52 @@
+// Type definitions for RxJS bindings for Node
+// Project: https://github.com/Reactive-Extensions/rx-node
+// Definitions by: Andre Luiz dos Santos <https://github.com/andre-luiz-dos-santos/>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+/// <reference path="rx.node.d.ts" />
+
+import RxNode = require('rx-node');
+
+{
+	var source = Rx.Observable.return(42);
+	var emitter = RxNode.toEventEmitter(source, 'data');
+
+	emitter.on('data', function(data: number) {
+		console.log('Data: ' + data);
+	});
+
+	emitter.on('end', function() {
+		console.log('End');
+	});
+
+	// Ensure to call publish to fire events from the observable
+	emitter.publish();
+}
+{
+	var subscription = RxNode.fromStream<string>(process.stdin, 'end')
+		.subscribe(function(x) { console.log(x); });
+}
+{
+	var subscription = RxNode.fromReadableStream(process.stdin)
+		.subscribe(function(x) { console.log(x); });
+}
+{
+	var readline = require('readline');
+	var fs = require('fs');
+
+	var rl = readline.createInterface({
+		input: fs.createReadStream('sample.txt')
+	});
+
+	var subscription = RxNode.fromReadLineStream(rl)
+		.subscribe(function(x) { console.log(x); });
+}
+{
+	var subscription = RxNode.fromWritableStream(process.stdout)
+		.subscribe(function(x) { console.log(x); });
+}
+{
+	var source = Rx.Observable.range(0, 5);
+	var subscription = RxNode.writeToStream(source, process.stdout, 'utf8');
+}

rx-node/rx.node.d.ts

@@ -0,0 +1,77 @@
+// Type definitions for RxJS bindings for Node
+// Project: https://github.com/Reactive-Extensions/rx-node
+// Definitions by: Andre Luiz dos Santos <https://github.com/andre-luiz-dos-santos/>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+/// <reference path="../rx/rx.d.ts" />
+
+declare namespace RxNode {
+
+	export interface PublishableEventEmitter extends NodeJS.EventEmitter {
+		publish(): void;
+	}
+
+	/**
+	 * Converts the given observable sequence to an event emitter with the given event name.
+	 * The errors are handled on the 'error' event and completion on the 'end' event.
+	 * You must call publish in order to invoke the subscription on the Observable sequence.
+	 * @param {Observable} observable The observable sequence to convert to an EventEmitter.
+	 * @param {String} eventName The event name to emit onNext calls.
+	 * @returns {EventEmitter} An EventEmitter which emits the given eventName for each onNext call in addition to 'error' and 'end' events.
+	 */
+	function toEventEmitter<T>(observable: Rx.Observable<T>, eventName: string): RxNode.PublishableEventEmitter;
+
+	/**
+	 * Converts a flowing stream to an Observable sequence.
+	 * @param {Stream} stream A stream to convert to a observable sequence.
+	 * @param {String} [finishEventName] Event that notifies about closed stream. ("end" by default)
+	 * @param {String} [dataEventName] Event that notifies about incoming data. ("data" by default)
+	 * @returns {Observable} An observable sequence which fires on each 'data' event as well as handling 'error' and finish events like `end` or `finish`.
+	 */
+	function fromStream<T>(stream: NodeJS.ReadableStream, finishEventName?: string, dataEventName?: string): Rx.Observable<T>;
+
+	/**
+	 * Converts a flowing readable stream to an Observable sequence.
+	 * @param {Stream} stream A stream to convert to a observable sequence.
+	 * @param {String} [dataEventName] Event that notifies about incoming data. ("data" by default)
+	 * @returns {Observable} An observable sequence which fires on each 'data' event as well as handling 'error' and 'end' events.
+	 */
+	function fromReadableStream<T>(stream: NodeJS.ReadableStream, dataEventName?: string): Rx.Observable<T>;
+
+	/**
+	 * Converts a flowing readline stream to an Observable sequence.
+	 * @param {Stream} stream A stream to convert to a observable sequence.
+	 * @returns {Observable} An observable sequence which fires on each 'data' event as well as handling 'error' and 'end' events.
+	 */
+	function fromReadLineStream<T>(stream: NodeJS.ReadableStream): Rx.Observable<T>;
+
+	/**
+	 * Converts a flowing writeable stream to an Observable sequence.
+	 * @param {Stream} stream A stream to convert to a observable sequence.
+	 * @returns {Observable} An observable sequence which fires on each 'data' event as well as handling 'error' and 'finish' events.
+	 */
+	function fromWritableStream<T>(stream: NodeJS.WritableStream): Rx.Observable<T>;
+
+	/**
+	 * Converts a flowing transform stream to an Observable sequence.
+	 * @param {Stream} stream A stream to convert to a observable sequence.
+	 * @param {String} [dataEventName] Event that notifies about incoming data. ("data" by default)
+	 * @returns {Observable} An observable sequence which fires on each 'data' event as well as handling 'error' and 'finish' events.
+	 */
+	function fromTransformStream<T>(stream: NodeJS.ReadWriteStream, dataEventName?: string): Rx.Observable<T>;
+
+	/**
+	 * Writes an observable sequence to a stream
+	 * @param {Observable} observable Observable sequence to write to a stream.
+	 * @param {Stream} stream The stream to write to.
+	 * @param {String} [encoding] The encoding of the item to write.
+	 * @returns {Disposable} The subscription handle.
+	 */
+	function writeToStream<T>(observable: Rx.Observable<T>, stream: NodeJS.WritableStream, encoding: string): Rx.Disposable;
+
+}
+
+declare module "rx-node" {
+	export = RxNode;
+}