Build Status Coverage Status npm version

What is Destroyable?

Destroyable is an abstract class which implements the OnDestroy life-cycle hook in Angular, and when the hook gets triggered a protected observable named _destroyed$ will emit once and then complete.

You can then use takeUntil(this._destroyed$) when subscribing to observables from inside your component, and the subscription will automatically end when the component has been destroyed.

The usage of takeUntil(this._destroyed$) is a popular best practice for Angular projects. You can find a lot of tutorials online discussing the practice.

Changelog

For details on recent changes, releases and Angular version support, please see the change log.

Learn about the latest improvements.

Installation

To get started, install the package from npm.

npm install @reactgular/destroyable

To install Angular 8 or 9 versions npm install @reactgular/destroyable@1.0.1

Usage

Allows you to easily add takeUntil(this._destroyed$) to components, modules and services in an Angular application.

The following example component prints ascending numbers to the console for as long as the component lives.

import {Component, OnInit} from '@angular/core';
import {interval} from 'rxjs';
import {takeUntil} from 'rxjs/operators';
import {Destroyable} from '@reactgular/destroyable';

@Component({
    selector: 'example'
    template: ''
})
export class ExampleComponent extends Destroyable implements OnInit {
  public ngOnInit(): void {
    interval(1000).pipe(
      takeUntil(this._destroyed$)
    ).subscribe(value => console.log(value));
  }
}

When implementing OnDestroy it's very important to call super.ngOnDestroy() for the base class, but it's not necessary to implement the interface because Destroyable already implements it.

export class ExampleComponent extends Destroyable implements OnDestroy {
    public constructor() {
        super();
    }

    public ngOnDestroy() {
        super.ngOnDestroy();
    }
}

Mixin

Destroyable supports mixins to use a different base class with your Angular components. The only limitation is that TypeScript doesn't currently support abstract classes for use with mixins.

import {Component, OnInit} from '@angular/core';
import {interval} from 'rxjs';
import {takeUntil} from 'rxjs/operators';
import {mixinDestroyable} from '@reactgular/destroyable';

@Directive()
class BaseDirective {
}

@Component({
    selector: 'example'
    template: ''
})
export class ExampleComponent extends mixinDestroyable(BaseDirective) implements OnInit {
  public ngOnInit(): void {
    interval(1000).pipe(
      takeUntil(this._destroyed$)
    ).subscribe(value => console.log(value));
  }
}

Last updated

v2.0.0

Install

npm install @reactgular/destroyable
yarn add @reactgular/destroyable

BUNDLE SIZE

Not Available

DOWNLOAD TIME

Not Available

CDNs

extras

Contributors

  • reactgular