2015-10-29 22:57:28 -04:00
|
|
|
import {global, isPresent, noop} from 'angular2/src/facade/lang';
|
2015-10-14 12:41:15 -04:00
|
|
|
// We make sure promises are in a separate file so that we can use promises
|
|
|
|
// without depending on rxjs.
|
2015-12-01 16:18:16 -05:00
|
|
|
import {Promise} from 'angular2/src/facade/promise';
|
2015-11-06 20:34:07 -05:00
|
|
|
export {PromiseWrapper, Promise, PromiseCompleter} from 'angular2/src/facade/promise';
|
2015-11-14 03:02:57 -05:00
|
|
|
|
2015-11-30 20:22:52 -05:00
|
|
|
import {Subject} from 'rxjs/Subject';
|
|
|
|
import {Observable as RxObservable} from 'rxjs/Observable';
|
|
|
|
import {Subscription} from 'rxjs/Subscription';
|
|
|
|
import {Operator} from 'rxjs/Operator';
|
|
|
|
|
2015-12-04 12:09:57 -05:00
|
|
|
import {PromiseObservable} from 'rxjs/observable/fromPromise';
|
|
|
|
import {toPromise} from 'rxjs/operator/toPromise';
|
2015-11-30 20:22:52 -05:00
|
|
|
|
|
|
|
export {Subject} from 'rxjs/Subject';
|
|
|
|
|
2015-10-01 22:49:45 -04:00
|
|
|
export namespace NodeJS {
|
|
|
|
export interface Timer {}
|
|
|
|
}
|
|
|
|
|
2015-05-19 10:47:30 -04:00
|
|
|
export class TimerWrapper {
|
2015-10-09 20:21:25 -04:00
|
|
|
static setTimeout(fn: (...args: any[]) => void, millis: number): NodeJS.Timer {
|
|
|
|
return global.setTimeout(fn, millis);
|
|
|
|
}
|
2015-10-01 22:49:45 -04:00
|
|
|
static clearTimeout(id: NodeJS.Timer): void { global.clearTimeout(id); }
|
2015-05-12 10:28:57 -04:00
|
|
|
|
2015-10-01 22:49:45 -04:00
|
|
|
static setInterval(fn: (...args: any[]) => void, millis: number): NodeJS.Timer {
|
2015-08-20 19:25:34 -04:00
|
|
|
return global.setInterval(fn, millis);
|
|
|
|
}
|
2015-10-01 22:49:45 -04:00
|
|
|
static clearInterval(id: NodeJS.Timer): void { global.clearInterval(id); }
|
2015-04-01 13:45:56 -04:00
|
|
|
}
|
|
|
|
|
2015-04-14 17:34:41 -04:00
|
|
|
export class ObservableWrapper {
|
2015-08-06 12:52:33 -04:00
|
|
|
// TODO(vsavkin): when we use rxnext, try inferring the generic type from the first arg
|
2015-10-29 00:49:22 -04:00
|
|
|
static subscribe<T>(emitter: any, onNext: (value: T) => void, onError?: (exception: any) => void,
|
2015-11-02 12:58:42 -05:00
|
|
|
onComplete: () => void = () => {}): Object {
|
2015-10-29 22:57:28 -04:00
|
|
|
onError = (typeof onError === "function") && onError || noop;
|
|
|
|
onComplete = (typeof onComplete === "function") && onComplete || noop;
|
2015-10-24 21:48:43 -04:00
|
|
|
return emitter.subscribe({next: onNext, error: onError, complete: onComplete});
|
2015-04-14 17:34:41 -04:00
|
|
|
}
|
|
|
|
|
2015-12-04 18:33:41 -05:00
|
|
|
static isObservable(obs: any): boolean { return !!obs.subscribe; }
|
2015-04-19 15:45:08 -04:00
|
|
|
|
2015-10-19 17:41:15 -04:00
|
|
|
/**
|
|
|
|
* Returns whether `obs` has any subscribers listening to events.
|
|
|
|
*/
|
2015-10-24 21:48:43 -04:00
|
|
|
static hasSubscribers(obs: EventEmitter<any>): boolean { return obs.observers.length > 0; }
|
2015-10-19 17:41:15 -04:00
|
|
|
|
2015-09-11 18:38:09 -04:00
|
|
|
static dispose(subscription: any) { subscription.unsubscribe(); }
|
2015-04-19 15:45:08 -04:00
|
|
|
|
2015-11-16 02:58:59 -05:00
|
|
|
/**
|
|
|
|
* @deprecated - use callEmit() instead
|
|
|
|
*/
|
2015-10-24 21:48:43 -04:00
|
|
|
static callNext(emitter: EventEmitter<any>, value: any) { emitter.next(value); }
|
2015-04-14 17:34:41 -04:00
|
|
|
|
2015-11-16 02:58:59 -05:00
|
|
|
static callEmit(emitter: EventEmitter<any>, value: any) { emitter.emit(value); }
|
|
|
|
|
2015-10-24 21:48:43 -04:00
|
|
|
static callError(emitter: EventEmitter<any>, error: any) { emitter.error(error); }
|
2015-04-14 17:34:41 -04:00
|
|
|
|
2015-10-24 21:48:43 -04:00
|
|
|
static callComplete(emitter: EventEmitter<any>) { emitter.complete(); }
|
2015-11-02 12:58:42 -05:00
|
|
|
|
|
|
|
static fromPromise(promise: Promise<any>): Observable<any> {
|
2015-12-04 12:09:57 -05:00
|
|
|
return PromiseObservable.create(promise);
|
2015-11-02 12:58:42 -05:00
|
|
|
}
|
2015-11-02 14:57:31 -05:00
|
|
|
|
2015-12-04 12:09:57 -05:00
|
|
|
static toPromise(obj: Observable<any>): Promise<any> { return toPromise.call(obj); }
|
2015-04-14 17:34:41 -04:00
|
|
|
}
|
|
|
|
|
2015-04-01 13:45:56 -04:00
|
|
|
/**
|
2015-09-30 23:59:23 -04:00
|
|
|
* Use by directives and components to emit custom Events.
|
2015-09-03 19:17:23 -04:00
|
|
|
*
|
2015-10-19 10:37:32 -04:00
|
|
|
* ### Examples
|
2015-09-03 19:17:23 -04:00
|
|
|
*
|
|
|
|
* In the following example, `Zippy` alternatively emits `open` and `close` events when its
|
|
|
|
* title gets clicked:
|
|
|
|
*
|
|
|
|
* ```
|
2015-10-11 10:41:19 -04:00
|
|
|
* @Component({
|
|
|
|
* selector: 'zippy',
|
|
|
|
* template: `
|
2015-09-03 19:17:23 -04:00
|
|
|
* <div class="zippy">
|
|
|
|
* <div (click)="toggle()">Toggle</div>
|
|
|
|
* <div [hidden]="!visible">
|
|
|
|
* <ng-content></ng-content>
|
|
|
|
* </div>
|
|
|
|
* </div>`})
|
|
|
|
* export class Zippy {
|
|
|
|
* visible: boolean = true;
|
2015-11-19 17:10:50 -05:00
|
|
|
* @Output() open: EventEmitter<any> = new EventEmitter();
|
|
|
|
* @Output() close: EventEmitter<any> = new EventEmitter();
|
2015-09-03 19:17:23 -04:00
|
|
|
*
|
|
|
|
* toggle() {
|
|
|
|
* this.visible = !this.visible;
|
|
|
|
* if (this.visible) {
|
2015-11-16 02:58:59 -05:00
|
|
|
* this.open.emit(null);
|
2015-09-03 19:17:23 -04:00
|
|
|
* } else {
|
2015-11-16 02:58:59 -05:00
|
|
|
* this.close.emit(null);
|
2015-09-03 19:17:23 -04:00
|
|
|
* }
|
|
|
|
* }
|
|
|
|
* }
|
|
|
|
* ```
|
|
|
|
*
|
2015-04-01 13:45:56 -04:00
|
|
|
* Use Rx.Observable but provides an adapter to make it work as specified here:
|
|
|
|
* https://github.com/jhusain/observable-spec
|
|
|
|
*
|
|
|
|
* Once a reference implementation of the spec is available, switch to it.
|
|
|
|
*/
|
2015-10-24 21:48:43 -04:00
|
|
|
export class EventEmitter<T> extends Subject<T> {
|
2015-10-19 17:41:15 -04:00
|
|
|
/** @internal */
|
|
|
|
_isAsync: boolean;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates an instance of [EventEmitter], which depending on [isAsync],
|
|
|
|
* delivers events synchronously or asynchronously.
|
|
|
|
*/
|
|
|
|
constructor(isAsync: boolean = true) {
|
|
|
|
super();
|
|
|
|
this._isAsync = isAsync;
|
|
|
|
}
|
2015-09-11 18:38:09 -04:00
|
|
|
|
2015-11-16 02:58:59 -05:00
|
|
|
emit(value: T) { super.next(value); }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @deprecated - use .emit(value) instead
|
|
|
|
*/
|
|
|
|
next(value: any) { super.next(value); }
|
|
|
|
|
2015-10-24 21:48:43 -04:00
|
|
|
subscribe(generatorOrNext?: any, error?: any, complete?: any): any {
|
2015-10-29 22:57:28 -04:00
|
|
|
let schedulerFn;
|
|
|
|
let errorFn = (err: any) => null;
|
|
|
|
let completeFn = () => null;
|
|
|
|
|
2015-10-24 21:48:43 -04:00
|
|
|
if (generatorOrNext && typeof generatorOrNext === 'object') {
|
2015-10-29 22:57:28 -04:00
|
|
|
schedulerFn = this._isAsync ? (value) => { setTimeout(() => generatorOrNext.next(value)); } :
|
|
|
|
(value) => { generatorOrNext.next(value); };
|
|
|
|
|
|
|
|
if (generatorOrNext.error) {
|
|
|
|
errorFn = this._isAsync ? (err) => { setTimeout(() => generatorOrNext.error(err)); } :
|
|
|
|
(err) => { generatorOrNext.error(err); };
|
|
|
|
}
|
|
|
|
|
|
|
|
if (generatorOrNext.complete) {
|
|
|
|
completeFn = this._isAsync ? () => { setTimeout(() => generatorOrNext.complete()); } :
|
|
|
|
() => { generatorOrNext.complete(); };
|
|
|
|
}
|
2015-10-24 21:48:43 -04:00
|
|
|
} else {
|
2015-10-29 22:57:28 -04:00
|
|
|
schedulerFn = this._isAsync ? (value) => { setTimeout(() => generatorOrNext(value)); } :
|
|
|
|
(value) => { generatorOrNext(value); };
|
|
|
|
|
|
|
|
if (error) {
|
|
|
|
errorFn =
|
|
|
|
this._isAsync ? (err) => { setTimeout(() => error(err)); } : (err) => { error(err); };
|
|
|
|
}
|
|
|
|
|
|
|
|
if (complete) {
|
|
|
|
completeFn =
|
|
|
|
this._isAsync ? () => { setTimeout(() => complete()); } : () => { complete(); };
|
|
|
|
}
|
2015-10-24 21:48:43 -04:00
|
|
|
}
|
2015-10-29 22:57:28 -04:00
|
|
|
|
|
|
|
return super.subscribe(schedulerFn, errorFn, completeFn);
|
2015-04-14 17:34:41 -04:00
|
|
|
}
|
2015-10-24 21:48:43 -04:00
|
|
|
}
|
2015-04-01 13:45:56 -04:00
|
|
|
|
2015-12-07 19:38:12 -05:00
|
|
|
/**
|
|
|
|
* Allows publishing and subscribing to series of async values.
|
|
|
|
*
|
|
|
|
* The `Observable` class is an alias to the `Observable` returned from
|
|
|
|
* {@link https://github.com/reactivex/rxjs}. `Observables` are a means of delivering
|
|
|
|
* any number of values over any period of time. `Observables` can be thought of as a
|
|
|
|
* mixture of `Promise` and `Array`. `Observables` are like `Arrays` in that they can have
|
|
|
|
* chained combinators -- like `map`, `reduce`, and `filter` -- attached in order to
|
|
|
|
* perform projections and transformations of data. And they are like `Promises`
|
|
|
|
* in that they can asynchronously deliver values. But unlike a `Promise`, an
|
|
|
|
* `Observable` can emit many values over time, and decides if/when it is completed.
|
|
|
|
*
|
|
|
|
* `Observable` is also being considered for inclusion in the
|
|
|
|
* [ECMAScript spec](https://github.com/zenparsing/es-observable).
|
|
|
|
*
|
|
|
|
* ## Example
|
|
|
|
*
|
|
|
|
* A simple example of using an `Observable` is a timer `Observable`, which will
|
|
|
|
* notify an `Observer` each time an interval has completed.
|
|
|
|
*
|
|
|
|
* {@example facade/ts/async/observable.ts region='Observable'}
|
|
|
|
*
|
|
|
|
* The `Observable` in Angular currently doesn't provide any combinators by default.
|
|
|
|
* So it's necessary to explicitly import any combinators that an application requires.
|
|
|
|
* There are two ways to import RxJS combinators: pure and patched. The "pure" approach
|
|
|
|
* involves importing a combinator as a function every place that an application needs it,
|
|
|
|
* then calling the function with the source observable as the context of the function.
|
|
|
|
*
|
|
|
|
* ## Example
|
|
|
|
*
|
|
|
|
* {@example facade/ts/async/observable_pure.ts region='Observable'}
|
|
|
|
*
|
|
|
|
* The "patched" approach to using combinators is to import a special module for
|
|
|
|
* each combinator, which will automatically cause the combinator to be patched
|
|
|
|
* to the `Observable` prototype, which will make it available to use anywhere in
|
|
|
|
* an application after the combinator has been imported once.
|
|
|
|
*
|
|
|
|
* ## Example
|
|
|
|
*
|
|
|
|
* (Notice the extra "add" in the path to import `map`)
|
|
|
|
*
|
|
|
|
* {@example facade/ts/async/observable_patched.ts region='Observable'}
|
|
|
|
*
|
|
|
|
* Notice that the sequence of operations is now able to be expressed "left-to-right"
|
|
|
|
* because `map` is on the `Observable` prototype. For a simple example like this one,
|
|
|
|
* the left-to-right expression may seem insignificant. However, when several operators
|
|
|
|
* are used in combination, the "callback tree" grows several levels deep, and becomes
|
|
|
|
* difficult to read. For this reason, the "patched" approach is the recommended approach
|
|
|
|
* to add new operators to `Observable`.
|
|
|
|
*
|
|
|
|
* For applications that are less sensitive about payload size, the set of core operators
|
|
|
|
* can be patched onto the `Observable` prototype with a single import, by importing the
|
|
|
|
* `rxjs` module.
|
|
|
|
*
|
|
|
|
* {@example facade/ts/async/observable_all.ts region='Observable'}
|
|
|
|
*
|
|
|
|
* Full documentation on RxJS `Observable` and available combinators can be found
|
|
|
|
* in the RxJS [Observable docs](http://reactivex.io/RxJS/class/es6/Observable.js~Observable.html).
|
|
|
|
*
|
|
|
|
*/
|
2015-10-24 21:48:43 -04:00
|
|
|
// todo(robwormald): ts2dart should handle this properly
|
|
|
|
export class Observable<T> extends RxObservable<T> {
|
|
|
|
lift<T, R>(operator: Operator<T, R>): Observable<T> {
|
|
|
|
const observable = new Observable();
|
|
|
|
observable.source = this;
|
|
|
|
observable.operator = operator;
|
|
|
|
return observable;
|
|
|
|
}
|
2015-04-27 19:11:20 -04:00
|
|
|
}
|