Skip to content

docs(LifecycleHooks): correct ngDoCheck description #8807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mhevery merged 1 commit into from
May 26, 2016
Merged

docs(LifecycleHooks): correct ngDoCheck description #8807

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions modules/@angular/core/src/metadata/lifecycle_hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,22 +118,19 @@ export abstract class OnChanges { abstract ngOnChanges(changes: {[key: string]:
export abstract class OnInit { abstract ngOnInit(); }

/**
* Implement this interface to override the default change detection algorithm for your directive.
* Implement this interface to supplement the default change detection algorithm in your directive.
*
* `ngDoCheck` gets called to check the changes in the directives instead of the default algorithm.
* `ngDoCheck` gets called to check the changes in the directives in addition to the default algorithm.
*
* The default change detection algorithm looks for differences by comparing bound-property values
* by reference across change detection runs. When `DoCheck` is implemented, the default algorithm
* is disabled and `ngDoCheck` is responsible for checking for changes.
* by reference across change detection runs.
*
* Implementing this interface allows improving performance by using insights about the component,
* its implementation and data types of its properties.
* Note that a directive typically should not use both `DoCheck` and {@link OnChanges} to respond to
* changes on the same input. `ngOnChanges` will continue to be called when the default change detector
* detects changes, so it is usually unnecessary to respond to changes on the same input in both hooks.
* Reaction to the changes have to be handled from within the `ngDoCheck` callback.
*
* Note that a directive should not implement both `DoCheck` and {@link OnChanges} at the same time.
* `ngOnChanges` would not be called when a directive implements `DoCheck`. Reaction to the changes
* have to be handled from within the `ngDoCheck` callback.
*
* Use {@link KeyValueDiffers} and {@link IterableDiffers} to add your custom check mechanisms.
* You can use {@link KeyValueDiffers} and {@link IterableDiffers} to help add your custom check mechanisms.
*
* ### Example ([live demo](http://plnkr.co/edit/QpnIlF0CR2i5bcYbHEUJ?p=preview))
*
Expand Down