Interface Observable

Hierarchy

Index

Methods

Methods

public asObservable(): Observable

Returns

Observable

public catch(handler: (exception: any) => Rx.Observable<T>): Observable

Parameters

  • handler: (exception: any) => Rx.Observable<T>

Returns

Observable

public catch(handler: (exception: any) => Rx.IPromise<T>): Observable

Parameters

  • handler: (exception: any) => Rx.IPromise<T>

Returns

Observable

public catch(second: Observable): Observable

Parameters

Returns

Observable

public catchException(handler: (exception: any) => Rx.Observable<T>): Observable

Parameters

  • handler: (exception: any) => Rx.Observable<T>

Returns

Observable

public catchException(handler: (exception: any) => Rx.IPromise<T>): Observable

Parameters

  • handler: (exception: any) => Rx.IPromise<T>

Returns

Observable

public catchException(second: Observable): Observable

Parameters

Returns

Observable

public combineLatest(second: Observable, resultSelector: (v1: T, v2: T2) => TResult): Observable

Parameters

  • second: Observable
  • resultSelector: (v1: T, v2: T2) => TResult

Returns

Observable

public combineLatest(second: IPromise, resultSelector: (v1: T, v2: T2) => TResult): Observable

Parameters

  • second: IPromise
  • resultSelector: (v1: T, v2: T2) => TResult

Returns

Observable

public combineLatest(second: Observable, third: Observable, resultSelector: (v1: T, v2: T2, v3: T3) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(second: Observable, third: IPromise, resultSelector: (v1: T, v2: T2, v3: T3) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(second: IPromise, third: Observable, resultSelector: (v1: T, v2: T2, v3: T3) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(second: IPromise, third: IPromise, resultSelector: (v1: T, v2: T2, v3: T3) => TResult): Observable

Parameters

  • second: IPromise
  • third: IPromise
  • resultSelector: (v1: T, v2: T2, v3: T3) => TResult

Returns

Observable

public combineLatest(second: Observable, third: Observable, fourth: Observable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(second: Observable, third: Observable, fourth: IPromise, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(second: Observable, third: IPromise, fourth: Observable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(second: Observable, third: IPromise, fourth: IPromise, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(second: IPromise, third: Observable, fourth: Observable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(second: IPromise, third: Observable, fourth: IPromise, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(second: IPromise, third: IPromise, fourth: Observable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(second: IPromise, third: IPromise, fourth: IPromise, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(second: Observable, third: Observable, fourth: Observable, fifth: Observable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4, v5: T5) => TResult): Observable

Parameters

Returns

Observable

public combineLatest(souces: Observable[], resultSelector: (firstValue: T, ...otherValues: TOther[]) => TResult): Observable

Parameters

  • souces: Observable[]
  • resultSelector: (firstValue: T, ...otherValues: TOther[]) => TResult

Returns

Observable

public combineLatest(souces: IPromise[], resultSelector: (firstValue: T, ...otherValues: TOther[]) => TResult): Observable

Parameters

  • souces: IPromise[]
  • resultSelector: (firstValue: T, ...otherValues: TOther[]) => TResult

Returns

Observable

public concat(sources?: Observable[]): Observable

Parameters

Returns

Observable

public concat(sources?: IPromise[]): Observable

Parameters

Returns

Observable

public concat(sources: Observable[]): Observable

Parameters

Returns

Observable

public concat(sources: IPromise[]): Observable

Parameters

Returns

Observable

public concatAll(): T in Rx.Observable<T>

Returns

T in Rx.Observable<T>

public concatMap(selector: (value: T, index: number) => Rx.Observable<T2>, resultSelector: (value1: T, value2: T2, index: number) => R): Observable

Parameters

  • selector: (value: T, index: number) => Rx.Observable<T2>
  • resultSelector: (value1: T, value2: T2, index: number) => R

Returns

Observable

public concatMap(selector: (value: T, index: number) => Rx.IPromise<T2>, resultSelector: (value1: T, value2: T2, index: number) => R): Observable

Parameters

  • selector: (value: T, index: number) => Rx.IPromise<T2>
  • resultSelector: (value1: T, value2: T2, index: number) => R

Returns

Observable

public concatMap(selector: (value: T, index: number) => Rx.Observable<R>): Observable

Parameters

  • selector: (value: T, index: number) => Rx.Observable<R>

Returns

Observable

public concatMap(selector: (value: T, index: number) => Rx.IPromise<R>): Observable

Parameters

  • selector: (value: T, index: number) => Rx.IPromise<R>

Returns

Observable

public concatMap(sequence: Observable): Observable

Parameters

Returns

Observable

public concatObservable(): T in Rx.Observable<T>

Returns

T in Rx.Observable<T>

public controlled(enableQueue?: boolean): ControlledObservable

Attaches a controller to the observable sequence with the ability to queue.

example

var source = Rx.Observable.interval(100).controlled(); source.request(3); // Reads 3 values

Parameters

  • enableQueue?: boolean optional

Returns

ControlledObservable

public dematerialize(): Observable

Returns

Observable

public distinctUntilChanged(skipParameter: boolean, comparer: (x: T, y: T) => boolean): Observable

Parameters

  • skipParameter: boolean
  • comparer: (x: T, y: T) => boolean

Returns

Observable

public distinctUntilChanged(keySelector?: (value: T) => TValue, comparer?: (x: TValue, y: TValue) => boolean): Observable

Parameters

  • keySelector?: (value: T) => TValue optional
  • comparer?: (x: TValue, y: TValue) => boolean optional

Returns

Observable

public do(observer: Observer): Observable

Parameters

Returns

Observable

public do(onNext?: (value: T) => void, onError?: (exception: any) => void, onCompleted?: () => void): Observable

Parameters

  • onNext?: (value: T) => void optional
  • onError?: (exception: any) => void optional
  • onCompleted?: () => void optional

Returns

Observable

public doAction(observer: Observer): Observable

Parameters

Returns

Observable

public doAction(onNext?: (value: T) => void, onError?: (exception: any) => void, onCompleted?: () => void): Observable

Parameters

  • onNext?: (value: T) => void optional
  • onError?: (exception: any) => void optional
  • onCompleted?: () => void optional

Returns

Observable

public filter(predicate: (value: T, index: number, source: Rx.Observable<T>) => boolean, thisArg?: any): Observable

Parameters

  • predicate: (value: T, index: number, source: Rx.Observable<T>) => boolean
  • thisArg?: any optional

Returns

Observable

public finally(action: () => void): Observable

Parameters

  • action: () => void

Returns

Observable

public finallyAction(action: () => void): Observable

Parameters

  • action: () => void

Returns

Observable

public flatMap(selector: (value: T) => Rx.Observable<TOther>, resultSelector: (item: T, other: TOther) => TResult): Observable

Parameters

  • selector: (value: T) => Rx.Observable<TOther>
  • resultSelector: (item: T, other: TOther) => TResult

Returns

Observable

public flatMap(selector: (value: T) => Rx.IPromise<TOther>, resultSelector: (item: T, other: TOther) => TResult): Observable

Parameters

  • selector: (value: T) => Rx.IPromise<TOther>
  • resultSelector: (item: T, other: TOther) => TResult

Returns

Observable

public flatMap(selector: (value: T) => Rx.Observable<TResult>): Observable

Parameters

  • selector: (value: T) => Rx.Observable<TResult>

Returns

Observable

public flatMap(selector: (value: T) => Rx.IPromise<TResult>): Observable

Parameters

  • selector: (value: T) => Rx.IPromise<TResult>

Returns

Observable

public flatMap(other: Observable): Observable

Parameters

Returns

Observable

public flatMap(other: IPromise): Observable

Parameters

Returns

Observable

public flatMapLatest(selector: (value: T, index: number, source: Rx.Observable<T>) => TResult, thisArg?: any): Observable

Projects each element of an observable sequence into a new sequence of observable sequences by incorporating the element's index and then transforms an observable sequence of observable sequences into an observable sequence producing values only from the most recent observable sequence.

Parameters

  • selector: (value: T, index: number, source: Rx.Observable<T>) => TResult

    A transform function to apply to each source element; the second parameter of the function represents the index of the source element.

  • thisArg?: any optional

Returns

Observable

An observable sequence whose elements are the result of invoking the transform function on each element of source producing an Observable of Observable sequences and that at any point in time produces the elements of the most recent inner observable sequence that has been received.

public forEach(onNext?: (value: T) => void, onError?: (exception: any) => void, onCompleted?: () => void): IDisposable

Parameters

  • onNext?: (value: T) => void optional
  • onError?: (exception: any) => void optional
  • onCompleted?: () => void optional

Returns

IDisposable

public ignoreElements(): Observable

Returns

Observable

public map(selector: (value: T, index: number, source: Rx.Observable<T>) => TResult, thisArg?: any): Observable

Parameters

  • selector: (value: T, index: number, source: Rx.Observable<T>) => TResult
  • thisArg?: any optional

Returns

Observable

public materialize(): Observable

Returns

Observable

public merge(maxConcurrent: number): T in Rx.Observable<T>

Parameters

  • maxConcurrent: number

Returns

T in Rx.Observable<T>

public merge(other: Observable): Observable

Parameters

Returns

Observable

public merge(other: IPromise): Observable

Parameters

Returns

Observable

public mergeAll(): T in Rx.Observable<T>

Returns

T in Rx.Observable<T>

public mergeObservable(): T in Rx.Observable<T>

Returns

T in Rx.Observable<T>

public pausable(pauser: Observable): Observable

Pauses the underlying observable sequence based upon the observable sequence which yields true/false.

example

var pauser = new Rx.Subject(); var source = Rx.Observable.interval(100).pausable(pauser);

Parameters

  • pauser: Observable

    The observable sequence used to pause the underlying sequence.

Returns

Observable

The observable sequence which is paused based upon the pauser.

public pausable(pauser?: ISubject): PausableObservable

Parameters

Returns

PausableObservable

public pausableBuffered(pauser?: ISubject): PausableObservable

Pauses the underlying observable sequence based upon the observable sequence which yields true/false, and yields the values that were buffered while paused.

example

var pauser = new Rx.Subject(); var source = Rx.Observable.interval(100).pausableBuffered(pauser);

Parameters

  • pauser?: ISubject optional

    The observable sequence used to pause the underlying sequence.

Returns

PausableObservable

The observable sequence which is paused based upon the pauser.

public repeat(repeatCount?: number): Observable

Parameters

  • repeatCount?: number optional

Returns

Observable

public retry(retryCount?: number): Observable

Parameters

  • retryCount?: number optional

Returns

Observable

public scan(seed: TAcc, accumulator: (acc: TAcc, value: T) => TAcc): Observable

Parameters

  • seed: TAcc
  • accumulator: (acc: TAcc, value: T) => TAcc

Returns

Observable

public scan(accumulator: (acc: T, value: T) => T): Observable

Parameters

  • accumulator: (acc: T, value: T) => T

Returns

Observable

public select(selector: (value: T, index: number, source: Rx.Observable<T>) => TResult, thisArg?: any): Observable

Parameters

  • selector: (value: T, index: number, source: Rx.Observable<T>) => TResult
  • thisArg?: any optional

Returns

Observable

public selectConcat(selector: (value: T, index: number) => Rx.Observable<T2>, resultSelector: (value1: T, value2: T2, index: number) => R): Observable

Parameters

  • selector: (value: T, index: number) => Rx.Observable<T2>
  • resultSelector: (value1: T, value2: T2, index: number) => R

Returns

Observable

public selectConcat(selector: (value: T, index: number) => Rx.IPromise<T2>, resultSelector: (value1: T, value2: T2, index: number) => R): Observable

Parameters

  • selector: (value: T, index: number) => Rx.IPromise<T2>
  • resultSelector: (value1: T, value2: T2, index: number) => R

Returns

Observable

public selectConcat(selector: (value: T, index: number) => Rx.Observable<R>): Observable

Parameters

  • selector: (value: T, index: number) => Rx.Observable<R>

Returns

Observable

public selectConcat(selector: (value: T, index: number) => Rx.IPromise<R>): Observable

Parameters

  • selector: (value: T, index: number) => Rx.IPromise<R>

Returns

Observable

public selectConcat(sequence: Observable): Observable

Parameters

Returns

Observable

public selectMany(selector: (value: T) => Rx.Observable<TOther>, resultSelector: (item: T, other: TOther) => TResult): Observable

Parameters

  • selector: (value: T) => Rx.Observable<TOther>
  • resultSelector: (item: T, other: TOther) => TResult

Returns

Observable

public selectMany(selector: (value: T) => Rx.IPromise<TOther>, resultSelector: (item: T, other: TOther) => TResult): Observable

Parameters

  • selector: (value: T) => Rx.IPromise<TOther>
  • resultSelector: (item: T, other: TOther) => TResult

Returns

Observable

public selectMany(selector: (value: T) => Rx.Observable<TResult>): Observable

Parameters

  • selector: (value: T) => Rx.Observable<TResult>

Returns

Observable

public selectMany(selector: (value: T) => Rx.IPromise<TResult>): Observable

Parameters

  • selector: (value: T) => Rx.IPromise<TResult>

Returns

Observable

public selectMany(other: Observable): Observable

Parameters

Returns

Observable

public selectMany(other: IPromise): Observable

Parameters

Returns

Observable

public selectSwitch(selector: (value: T, index: number, source: Rx.Observable<T>) => TResult, thisArg?: any): Observable

Projects each element of an observable sequence into a new sequence of observable sequences by incorporating the element's index and then transforms an observable sequence of observable sequences into an observable sequence producing values only from the most recent observable sequence.

Parameters

  • selector: (value: T, index: number, source: Rx.Observable<T>) => TResult

    A transform function to apply to each source element; the second parameter of the function represents the index of the source element.

  • thisArg?: any optional

Returns

Observable

An observable sequence whose elements are the result of invoking the transform function on each element of source producing an Observable of Observable sequences and that at any point in time produces the elements of the most recent inner observable sequence that has been received.

public skip(count: number): Observable

Parameters

  • count: number

Returns

Observable

public skipLast(count: number): Observable

Parameters

  • count: number

Returns

Observable

public skipUntil(other: Observable): Observable

Parameters

Returns

Observable

public skipUntil(other: IPromise): Observable

Parameters

Returns

Observable

public skipWhile(predicate: (value: T, index: number, source: Rx.Observable<T>) => boolean, thisArg?: any): Observable

Parameters

  • predicate: (value: T, index: number, source: Rx.Observable<T>) => boolean
  • thisArg?: any optional

Returns

Observable

public startWith(values?: Array<T>): Observable

Parameters

  • values?: Array<T> optional

Returns

Observable

public startWith(scheduler: IScheduler, values?: Array<T>): Observable

Parameters

  • scheduler: IScheduler
  • values?: Array<T> optional

Returns

Observable

public subscribe(observer: Observer): IDisposable

Parameters

Returns

IDisposable

public subscribe(onNext?: (value: T) => void, onError?: (exception: any) => void, onCompleted?: () => void): IDisposable

Parameters

  • onNext?: (value: T) => void optional
  • onError?: (exception: any) => void optional
  • onCompleted?: () => void optional

Returns

IDisposable

public subscribe(observer: Observer): IDisposable

Parameters

Returns

IDisposable

public subscribe(onNext?: (value: T) => void, onError?: (exception: any) => void, onCompleted?: () => void): IDisposable

Parameters

  • onNext?: (value: T) => void optional
  • onError?: (exception: any) => void optional
  • onCompleted?: () => void optional

Returns

IDisposable

public switch(): T in Rx.Observable<T>

Returns

T in Rx.Observable<T>

public switchLatest(): T in Rx.Observable<T>

Returns

T in Rx.Observable<T>

public take(count: number, scheduler?: IScheduler): Observable

Parameters

Returns

Observable

public takeLast(count: number, scheduler?: IScheduler): Observable

Parameters

Returns

Observable

public takeLastBuffer(count: number): Observable

Parameters

  • count: number

Returns

Observable

public takeUntil(other: Observable): Observable

Parameters

Returns

Observable

public takeUntil(other: IPromise): Observable

Parameters

Returns

Observable

public takeWhile(predicate: (value: T, index: number, source: Rx.Observable<T>) => boolean, thisArg?: any): Observable

Parameters

  • predicate: (value: T, index: number, source: Rx.Observable<T>) => boolean
  • thisArg?: any optional

Returns

Observable

public toArray(): Observable

Returns

Observable

public toPromise(promiseCtor: new(resolver: (resolvePromise: (value: T) => void, rejectPromise: (reason: any) => void) => void) => TPromise): TPromise

Converts an existing observable sequence to an ES6 Compatible Promise

example

var promise = Rx.Observable.return(42).toPromise(RSVP.Promise);

Parameters

  • promiseCtor: new(resolver: (resolvePromise: (value: T) => void, rejectPromise: (reason: any) => void) => void) => TPromise

    The constructor of the promise.

Returns

TPromise

An ES6 compatible promise with the last value from the observable sequence.

public toPromise(promiseCtor?: new(resolver: (resolvePromise: (value: T) => void, rejectPromise: (reason: any) => void) => void) => Rx.IPromise<T>): IPromise

Converts an existing observable sequence to an ES6 Compatible Promise

example

var promise = Rx.Observable.return(42).toPromise(RSVP.Promise);

// With config Rx.config.Promise = RSVP.Promise; var promise = Rx.Observable.return(42).toPromise();

Parameters

  • promiseCtor?: new(resolver: (resolvePromise: (value: T) => void, rejectPromise: (reason: any) => void) => void) => Rx.IPromise<T> optional

Returns

IPromise

An ES6 compatible promise with the last value from the observable sequence.

public where(predicate: (value: T, index: number, source: Rx.Observable<T>) => boolean, thisArg?: any): Observable

Parameters

  • predicate: (value: T, index: number, source: Rx.Observable<T>) => boolean
  • thisArg?: any optional

Returns

Observable

public zip(second: Observable, resultSelector: (v1: T, v2: T2) => TResult): Observable

Parameters

  • second: Observable
  • resultSelector: (v1: T, v2: T2) => TResult

Returns

Observable

public zip(second: IPromise, resultSelector: (v1: T, v2: T2) => TResult): Observable

Parameters

  • second: IPromise
  • resultSelector: (v1: T, v2: T2) => TResult

Returns

Observable

public zip(second: Observable, third: Observable, resultSelector: (v1: T, v2: T2, v3: T3) => TResult): Observable

Parameters

Returns

Observable

public zip(second: Observable, third: IPromise, resultSelector: (v1: T, v2: T2, v3: T3) => TResult): Observable

Parameters

Returns

Observable

public zip(second: IPromise, third: Observable, resultSelector: (v1: T, v2: T2, v3: T3) => TResult): Observable

Parameters

Returns

Observable

public zip(second: IPromise, third: IPromise, resultSelector: (v1: T, v2: T2, v3: T3) => TResult): Observable

Parameters

  • second: IPromise
  • third: IPromise
  • resultSelector: (v1: T, v2: T2, v3: T3) => TResult

Returns

Observable

public zip(second: Observable, third: Observable, fourth: Observable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public zip(second: Observable, third: Observable, fourth: IPromise, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public zip(second: Observable, third: IPromise, fourth: Observable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public zip(second: Observable, third: IPromise, fourth: IPromise, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public zip(second: IPromise, third: Observable, fourth: Observable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public zip(second: IPromise, third: Observable, fourth: IPromise, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public zip(second: IPromise, third: IPromise, fourth: Observable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public zip(second: IPromise, third: IPromise, fourth: IPromise, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4) => TResult): Observable

Parameters

Returns

Observable

public zip(second: Observable, third: Observable, fourth: Observable, fifth: Observable, resultSelector: (v1: T, v2: T2, v3: T3, v4: T4, v5: T5) => TResult): Observable

Parameters

Returns

Observable

public zip(second: Observable[], resultSelector: (left: T, ...right: TOther[]) => TResult): Observable

Parameters

  • second: Observable[]
  • resultSelector: (left: T, ...right: TOther[]) => TResult

Returns

Observable

public zip(second: IPromise[], resultSelector: (left: T, ...right: TOther[]) => TResult): Observable

Parameters

  • second: IPromise[]
  • resultSelector: (left: T, ...right: TOther[]) => TResult

Returns

Observable