This is the archived documentation for Angular v6. Please visit angular.io to see documentation for the current version of Angular.
API > @angular/core

OnDestroy

A lifecycle hook that is called when a directive, pipe, or service is destroyed. Use for any custom cleanup that needs to occur when the instance is destroyed.

      
      interface OnDestroy {
  ngOnDestroy(): void
}

Class implementations

See also

Methods

ngOnDestroy()

A callback method that performs custom clean-up, invoked immediately after a directive, pipe, or service instance is destroyed.
ngOnDestroy(): void
      
      ngOnDestroy(): void

Parameters

There are no parameters.

Returns

void

Usage notes

The following snippet shows how a component can implement this interface to define its own custom clean-up method.

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