docs(change_detection): document LifeCycle
This commit is contained in:
parent
7cac7c5157
commit
d630d5baa5
|
@ -5,6 +5,29 @@ import {ExceptionHandler} from 'angular2/src/core/exception_handler';
|
|||
import {isPresent} from 'angular2/src/facade/lang';
|
||||
|
||||
/**
|
||||
* Provides access to explicitly trigger change detection in an application.
|
||||
*
|
||||
* By default, [Zone] triggers change detection in Angular on each virtual machine (VM) turn. When testing, or in some
|
||||
* limited application use cases, a developer can also trigger change detection with the `lifecycle.tick()` method.
|
||||
*
|
||||
* Each Angular application has a single `LifeCycle` instance.
|
||||
*
|
||||
* # Example
|
||||
*
|
||||
* This is a contrived example, since the bootstrap automatically runs inside of the [Zone], which invokes
|
||||
* `lifecycle.tick()` on your behalf.
|
||||
*
|
||||
* ```javascript
|
||||
* bootstrap(MyApp).then((ref:ComponentRef) => {
|
||||
* var lifeCycle = ref.injector.get(LifeCycle);
|
||||
* var myApp = ref.instance;
|
||||
*
|
||||
* ref.doSomething();
|
||||
* lifecycle.tick();
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
*
|
||||
* @exportedAs angular2/change_detection
|
||||
*/
|
||||
@Injectable()
|
||||
|
@ -33,6 +56,16 @@ export class LifeCycle {
|
|||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Invoke this method to explicitly process change detection and its side-effects.
|
||||
*
|
||||
* In development mode, `tick()` also performs a second change detection cycle to ensure that no further
|
||||
* changes are detected. If additional changes are picked up during this second cycle, bindings in the app have
|
||||
* side-effects that cannot be resolved in a single change detection pass. In this case, Angular throws an error,
|
||||
* since an Angular application can only have one change detection pass during which all change detection must
|
||||
* complete.
|
||||
*
|
||||
*/
|
||||
tick() {
|
||||
this._changeDetector.detectChanges();
|
||||
if (this._enforceNoNewChanges) {
|
||||
|
|
Loading…
Reference in New Issue