Home Manual Reference Source Repository

References

Class Summary

Static Public Class Summary
public

A normalized AJAX error

public

Creates an observable for an Ajax request with either a request object with url, headers, etc or a string for a URL.

public

A normalized AJAX response

public

an error thrown when an action is invalid because the object has been unsubscribed

public

A representation of any set of values over any amount of time.

Function Summary

Static Public Function Summary
public

buffer(closingNotifier: Observable<any>): Observable<T[]>

Buffers the incoming observable values until the passed closingNotifier emits a value, at which point it emits the buffer on the returned observable and starts a new buffer internally, awaiting the next time closingNotifier emits.

public

bufferCount(bufferSize: number, startBufferEvery: number): Observable<T[]>

Buffers a number of values from the source observable by bufferSize then emits the buffer and clears it, and starts a new buffer each startBufferEvery values.

public

bufferTime(bufferTimeSpan: number, bufferCreationInterval: number, scheduler: Scheduler): Observable<T[]>

Buffers values from the source for a specific time period.

public

bufferToggle(openings: Observable<O>, closingSelector: Function): Observable<T[]>

Buffers values from the source by opening the buffer via signals from an Observable provided to openings, and closing and sending the buffers when an Observable returned by the closingSelector emits.

public

bufferWhen(closingSelector: function): Observable<T[]>

Opens a buffer immediately, then closes the buffer when the observable returned by calling closingSelector emits a value.

public

Takes an Observable of Observables, and collects all observables from it.

public

combineLatest(observables: ...Observable, project: function): Observable

Combines the values from this observable with values from observables passed as arguments.

public

concat(observables: ...*): Observable

Joins this observable with multiple other observables by subscribing to them one at a time, starting with the source, and merging their results into the returned observable.

public

Joins every Observable emitted by the source (an Observable of Observables), in a serial fashion.

public

concatMap(project: function, resultSelector: function): Observable

Maps values from the source observable into new Observables, then merges them in a serialized fashion, waiting for each one to complete before merging the next.

public

concatMapTo(observable: Observable, resultSelector: function): Observable

Maps values from the source to a specific observable, and merges them together in a serialized fashion.

public

concatStatic(observables: ...*): Observable

Joins multiple observables together by subscribing to them one at a time and merging their results into the returned observable.

public

count(predicate: function): Observable

Returns an observable of a single number that represents the number of items that either: Match a provided predicate function, or if a predicate is not provided, the number represents the total count of all items in the source observable.

public

debounce(durationSelector: function): Observable

Returns the source Observable delayed by the computed debounce duration, with the duration lengthened if a new source item arrives before the delay duration ends.

public

debounceTime(dueTime: number, scheduler: Scheduler): Observable

Returns the source Observable delayed by the computed debounce duration, with the duration lengthened if a new source item arrives before the delay duration ends.

public

defaultIfEmpty(defaultValue: any): Observable

Returns an Observable that emits the elements of the source or a specified default value if empty.

public

delay(delay: number | Date, scheduler: Scheduler): Observable

Returns an Observable that delays the emission of items from the source Observable by a given timeout or until a given Date.

public

delayWhen(selector: Function, sequence: Observable): Observable

Returns an Observable that delays the emission of items from the source Observable by a subscription delay and a delay selector function for each element.

public

Returns an Observable that transforms Notification objects into the items or notifications they represent.

public

distinct(compare: function, flushes: Observable): Observable

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from previous items.

public

distinctKey(key: string, compare: function, flushes: Observable): Observable

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from previous items, using a property accessed by using the key provided to check if the two items are distinct.

public

Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item, using a property accessed by using the key provided to check if the two items are distinct.

public

elementAt(index: number, defaultValue: any): Observable

Returns an Observable that emits the item at the specified index in the source Observable.

public

every(predicate: function, thisArg: any): Observable

Returns an Observable that emits whether or not every item of the source satisfies the condition specified.

public

Returns an Observable that takes a source of observables and propagates the first observable exclusively until it completes before subscribing to the next.

public

exhaustMap(project: function, resultSelector: function): Observable

Returns an Observable that applies the given function to each item of the source Observable to create a new Observable, which are then concatenated together to produce a new Observable.

public

expand(project: function, concurrent: number, scheduler: Scheduler): Observable

Returns an Observable where for each item in the source Observable, the supplied function is applied to each item, resulting in a new value to then be applied again with the function.

public

filter(select: Function, thisArg: any): Observable

Similar to the well-known Array.prototype.filter method, this operator filters values down to a set allowed by a select function

public

find(predicate: function): Observable

Returns an Observable that searches for the first item in the source Observable that matches the specified condition, and returns the first occurrence in the source.

public

Returns an Observable that searches for the first item in the source Observable that matches the specified condition, and returns the the index of the item in the source.

public

first(predicate: function): Observable

Returns an Observable that emits the first item of the source Observable that matches the specified condition.

public

groupBy(keySelector: Function, elementSelector: Function): Observable

Groups the items emitted by an Observable according to a specified criterion, and emits these grouped items as GroupedObservables, one GroupedObservable per group.

public

Ignores all items emitted by the source Observable and only passes calls of complete or error.

public

If the source Observable is empty it returns an Observable that emits true, otherwise it emits false.

public

last(predicate: function): Observable

Returns an Observable that emits only the last item emitted by the source Observable.

public

map(project: Function, thisArg: any): Observable

Similar to the well known Array.prototype.map function, this operator applies a projection to each value and emits that projection in the returned observable

public

mapTo(value: any): Observable

Maps every value to the same value every time.

public

Returns an Observable that represents all of the emissions and notifications from the source Observable into emissions marked with their original types within a Notification objects.

public

max(optional: Function): Observable

The Max operator operates on an Observable that emits numbers (or items that can be evaluated as numbers), and when source Observable completes it emits a single item: the item with the largest number.

public

Creates a result Observable which emits values from every given input Observable.

public

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an Observable, and then merging those resulting Observables and emitting the results of this merger.

public

min(optional: Function): Observable<R>

The Min operator operates on an Observable that emits numbers (or items that can be evaluated as numbers), and when source Observable completes it emits a single item: the item with the smallest number.

public

Returns an Observable that emits the results of invoking a specified selector on items emitted by a ConnectableObservable that shares a single subscription to the underlying stream.

public

Returns a new observable that triggers on the second and following inputs.

public

pluck(properties: ...args): Observable

Retrieves the value of a specified nested property from all elements in the Observable sequence.

public

publish(): *

Returns a ConnectableObservable, which is a variety of Observable that waits until its connect method is called before it begins emitting items to those Observers that have subscribed to it.

public

Returns an Observable that mirrors the first source Observable to emit an item from the combination of this Observable and supplied Observables

public

Returns an Observable that mirrors the first source Observable to emit an item.

public

reduce(the: initialValue, an: accumulator): Observable

Returns an Observable that applies a specified accumulator function to the first item emitted by a source Observable, then feeds the result of that function along with the second item emitted by the source Observable into the same function, and so on until all items have been emitted by the source Observable, and emits the final result from the final call to your function as its sole item.

public

repeat(scheduler: Scheduler, count: number): Observable

Returns an Observable that repeats the stream of items emitted by the source Observable at most count times, on a particular Scheduler.

public

retry(number: number): Observable

Returns an Observable that mirrors the source Observable, resubscribing to it if it calls error and the predicate returns true for that specific exception and retry count.

public

retryWhen(receives: notificationHandler, the: scheduler): Observable

Returns an Observable that emits the same values as the source observable with the exception of an error.

public

sample(sampler: Observable): Observable<T>

Returns an Observable that, when the specified sampler Observable emits an item or completes, it then emits the most recently emitted item (if any) emitted by the source Observable since the previous emission from the sampler Observable.

public

scan(accumulator: function, seed: any): Obervable

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable.

public

Returns a new Observable that multicasts (shares) the original Observable.

public

Returns an Observable that emits the single item emitted by the source Observable that matches a specified predicate, if that Observable emits one such item.

public

Returns an Observable that skips n items emitted by an Observable.

public

Returns an Observable that skips items emitted by the source Observable until a second Observable emits an item.

public

skipWhile(predicate: Function): Observable<T>

Returns an Observable that skips all items emitted by the source Observable as long as a specified condition holds true, but emits all further source items as soon as the condition becomes false.

public

startWith(an: Values): Observable

Returns an Observable that emits the items in a specified Iterable before it begins to emit items emitted by the source Observable.

public

subscribeOn(the: Scheduler): Observable<T>

Asynchronously subscribes Observers to this Observable on the specified Scheduler.

public

Returns a new Observable by applying a function that you supply to each item emitted by the source Observable that returns an Observable, and then emitting the items emitted by the most recently emitted of these Observables.

public

withLatestFrom(observables: Observable, project: Function): *

Variable Summary

Static Public Variable Summary
public

rxSubscriber symbol is a symbol for retrieving an "Rx safe" Observer from an object "Rx safety" can be defined as an object that has all of the traits of an Rx Subscriber, including the ability to add and remove subscriptions to the subscription chain and guarantees involving event triggering (can't "next" after unsubscription, etc).