docs(pipes): improve docs for async pipe

Closes #4104
This commit is contained in:
Jeff Cross 2015-09-09 14:56:48 -07:00
parent 0653b82048
commit 2ab8c59ad5
2 changed files with 13 additions and 14 deletions

View File

@ -1,7 +1,7 @@
/** /**
* @module * @module
* @description * @description
* This module provides advanced support for extending change detection. * This module provides a set of common Pipes.
*/ */
export {AsyncPipe} from './pipes/async_pipe'; export {AsyncPipe} from './pipes/async_pipe';

View File

@ -36,28 +36,27 @@ var _observableStrategy = new ObservableStrategy();
/** /**
* Implements async bindings to Observable and Promise. * The `async` pipe subscribes to an Observable or Promise and returns the latest value it has
* emitted.
* When a new value is emitted, the `async` pipe marks the component to be checked for changes.
* *
* # Example * # Example
* The example below binds the `time` Observable to the view. Every 500ms, the `time` Observable
* updates the view with the current time.
* *
* In this example we bind the description observable to the DOM. The async pipe will convert an * import {Observable} from 'angular2/core';
*observable to the
* latest value it emitted. It will also request a change detection check when a new value is
*emitted.
*
* ```
* @Component({ * @Component({
* selector: "task-cmp", * selector: "task-cmp"
* changeDetection: ChangeDetectionStrategy.OnPush
* }) * })
* @View({ * @View({
* template: "Task Description {{ description | async }}" * template: "Time: {{ time | async }}"
* }) * })
* class Task { * class Task {
* description:Observable<string>; * time = new Observable<number>(observer => {
* setInterval(_ =>
* observer.next(new Date().getTime(), 500);
* });
* } * }
*
* ```
*/ */
@Pipe({name: 'async', pure: false}) @Pipe({name: 'async', pure: false})
@Injectable() @Injectable()