docs(async-pipe): include observable example (#8900)
Adds the missing example, usage case and a bit more description to the async-pipe.
This commit is contained in:
parent
10475b859d
commit
0c6b16c208
|
@ -36,22 +36,29 @@ var _observableStrategy = new ObservableStrategy();
|
||||||
var __unused: Promise<any>; // avoid unused import when Promise union types are erased
|
var __unused: Promise<any>; // avoid unused import when Promise union types are erased
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The `async` pipe subscribes to an Observable or Promise and returns the latest value it has
|
* The `async` pipe subscribes to an `Observable` or `Promise` and returns the latest value it has
|
||||||
* emitted.
|
* emitted.
|
||||||
* When a new value is emitted, the `async` pipe marks the component to be checked for changes.
|
* When a new value is emitted, the `async` pipe marks the component to be checked for changes.
|
||||||
|
* When the component gets destroyed, the `async` pipe unsubscribes automatically to avoid
|
||||||
|
* potential memory leaks.
|
||||||
*
|
*
|
||||||
* ### Example
|
* ## Usage
|
||||||
|
*
|
||||||
|
* object | async
|
||||||
|
*
|
||||||
|
* where `object` is of type `Observable` or of type `Promise`.
|
||||||
|
*
|
||||||
|
* ## Examples
|
||||||
*
|
*
|
||||||
* This example binds a `Promise` to the view. Clicking the `Resolve` button resolves the
|
* This example binds a `Promise` to the view. Clicking the `Resolve` button resolves the
|
||||||
* promise.
|
* promise.
|
||||||
*
|
*
|
||||||
* {@example core/pipes/ts/async_pipe/async_pipe_example.ts region='AsyncPipe'}
|
* {@example core/pipes/ts/async_pipe/async_pipe_example.ts region='AsyncPipePromise'}
|
||||||
*
|
*
|
||||||
* It's also possible to use `async` with Observables. The example below binds the `time` Observable
|
* It's also possible to use `async` with Observables. The example below binds the `time` Observable
|
||||||
* to the view. Every 500ms, the `time` Observable updates the view with the current time.
|
* to the view. Every 500ms, the `time` Observable updates the view with the current time.
|
||||||
*
|
*
|
||||||
* ```typescript
|
* {@example core/pipes/ts/async_pipe/async_pipe_example.ts region='AsyncPipeObservable'}
|
||||||
* ```
|
|
||||||
*/
|
*/
|
||||||
@Pipe({name: 'async', pure: false})
|
@Pipe({name: 'async', pure: false})
|
||||||
@Injectable()
|
@Injectable()
|
||||||
|
|
|
@ -2,7 +2,7 @@ import {Component, provide} from '@angular/core';
|
||||||
import {bootstrap} from '@angular/platform-browser';
|
import {bootstrap} from '@angular/platform-browser';
|
||||||
import {Observable, Subscriber} from 'rxjs/Rx';
|
import {Observable, Subscriber} from 'rxjs/Rx';
|
||||||
|
|
||||||
// #docregion AsyncPipe
|
// #docregion AsyncPipePromise
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'async-example',
|
selector: 'async-example',
|
||||||
template: `<div>
|
template: `<div>
|
||||||
|
|
Loading…
Reference in New Issue