diff --git a/rx.js/rx.d.ts b/rx.js/rx.d.ts index 640fe8ff7..1100bc618 100644 --- a/rx.js/rx.d.ts +++ b/rx.js/rx.d.ts @@ -1,4 +1,4 @@ -// Type definitions for RxJS v2.2.15 +// Type definitions for RxJS v2.2.17 // Project: http://rx.codeplex.com/ // Definitions by: gsino // Definitions by: Igor Oleinikov @@ -381,17 +381,29 @@ declare module Rx { fromPromise(promise: IPromise): Observable; /** - * Converts a generator function to an observable sequence, using an optional scheduler to enumerate the generator. - * BUG: it have been defined for Observable instance. + * Converts an iterable into an Observable sequence * * @example - * var res = Rx.Observable.fromGenerator(function* () { yield 42; }); - * var res = Rx.Observable.fromArray(function* () { yield 42; }, Rx.Scheduler.timeout); - * @param genFn Generator function. + * var res = Rx.Observable.fromIterable(new Map()); + * var res = Rx.Observable.fromIterable(function* () { yield 42; }); + * var res = Rx.Observable.fromIterable(new Set(), Rx.Scheduler.timeout); + * @param generator Generator to convert from. * @param [scheduler] Scheduler to run the enumeration of the input sequence on. * @returns The observable sequence whose elements are pulled from the given generator sequence. */ - fromGenerator(genFn: () => { next(): { done: boolean; value?: T; }; }, scheduler?: IScheduler): Observable; + fromItreable(generator: () => { next(): { done: boolean; value?: T; }; }, scheduler?: IScheduler): Observable; + + /** + * Converts an iterable into an Observable sequence + * + * @example + * var res = Rx.Observable.fromIterable(new Map()); + * var res = Rx.Observable.fromIterable(new Set(), Rx.Scheduler.timeout); + * @param iterable Iterable to convert from. + * @param [scheduler] Scheduler to run the enumeration of the input sequence on. + * @returns The observable sequence whose elements are pulled from the given generator sequence. + */ + fromItreable(iterable: {}, scheduler?: IScheduler): Observable; // todo: can't describe ES6 Iterable via TypeScript type system } export var Observable: ObservableStatic;