From 544df1879ba447c4390a58dedfc5f1420cff1a7b Mon Sep 17 00:00:00 2001 From: Giuseppe Scoppino Date: Sat, 23 Jul 2016 18:50:50 -0400 Subject: [PATCH] docs(guide/component): document `$doCheck` in the component guide The docs for `$compile` were updated in e235f20 to include information about the recently implemented `$doCheck` lifecycle hook for component controllers. The lifecycle hook documentation is mirrored in the Component guide, and this change mirrors the update made to the `$compile` docs, to the component guide docs. Closes #14946 --- docs/content/guide/component.ngdoc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/content/guide/component.ngdoc b/docs/content/guide/component.ngdoc index 473bc42ae..c5c2a6df2 100644 --- a/docs/content/guide/component.ngdoc +++ b/docs/content/guide/component.ngdoc @@ -160,6 +160,12 @@ of the component. The following hook methods can be implemented: are the names of the bound properties that have changed, and the values are an object of the form `{ currentValue, previousValue, isFirstChange() }`. Use this hook to trigger updates within a component such as cloning the bound value to prevent accidental mutation of the outer value. + * `$doCheck()` - Called on each turn of the digest cycle. Provides an opportunity to detect and act on + changes. Any actions that you wish to take in response to the changes that you detect must be + invoked from this hook; implementing this has no effect on when `$onChanges` is called. For example, this hook + could be useful if you wish to perform a deep equality check, or to check a Date object, changes to which would not + be detected by Angular's change detector and thus not trigger `$onChanges`. This hook is invoked with no arguments; + if detecting changes, you must store the previous value(s) for comparison to the current values. * `$onDestroy()` - Called on a controller when its containing scope is destroyed. Use this hook for releasing external resources, watches and event handlers. * `$postLink()` - Called after this controller's element and its children have been linked. Similar to the post-link