DoCheck

From Get docs
< @angular/coreAngular/docs/11/api/core/docheck


DoCheck

interface

A lifecycle hook that invokes a custom change-detection function for a directive, in addition to the check performed by the default change-detector.

See more...

interface DoCheck {
  ngDoCheck(): void
}

Class implementations

  • NgClass
  • NgForOf
  • NgStyle
  • NgSwitchCase
  • UpgradeComponent


See also

Description

The default change-detection algorithm looks for differences by comparing bound-property values by reference across change detection runs. You can use this hook to check for and respond to changes by some other means.

When the default change detector detects changes, it invokes ngOnChanges() if supplied, regardless of whether you perform additional change detection. Typically, you should not use both DoCheck and OnChanges to respond to changes on the same input.

Further information available in the Usage Notes...

Methods

A callback method that performs change-detection, invoked after the default change-detector runs. See KeyValueDiffers and IterableDiffers for implementing custom change checking for collections.

ngDoCheck(): void

Parameters

There are no parameters.

Returns

void


Usage notes

The following snippet shows how a component can implement this interface to invoke it own change-detection cycle.

@Component({selector: 'my-cmp', template: `...`})
class MyComponent implements DoCheck {
  ngDoCheck() {
    // ...
  }
}

For a more complete example and discussion, see Defining custom change detection.


© 2010–2021 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v11.angular.io/api/core/DoCheck