Notwithstanding Previous Misdemeanors
Have ideas to improve npm?Join in the discussion! »

ngx-hocs-unsubscriberTypeScript icon, indicating that this package has built-in type declarations

1.1.7 • Public • Published

ngx-hocs-unsubscriber

Higher-oder component to automatically unsubscribe from observables in Angular component classes.

Prerequisite

Your Angular project must be running at least Angular version 9.

If that is not a problem, install the library:

npm i ngx-hocs-unsubscriber

Usage

Just import Unsubscriber and autoComplete in your component class.

Use Unsubscriber as a Typescript Class decorator and autoComplete(this) as a RxJS operator, right at the end of your pipe/s.

As simple as that.

You do not need to implement the OnDestroy interface so you would only need to write the ngOnDestroy() method if you needed to add extra actions to that Angular lifecycle hook.

import { Component, OnDestroy, OnInit } from '@angular/core';
import { autoComplete, Unsubscriber } from 'ngx-hocs-unsubscriber';
import { interval, Observable, Subscription } from 'rxjs';
import { tap } from 'rxjs/operators';
 
@Unsubscriber()
@Component({})
export class SubscribedComponent implements OnInit, OnDestroy {
  observable$: Observable<number> = interval(1000);
  subscription$$: Subscription;
 
  ngOnInit(): void {
    this.subscription$$ = this.observable$
      .pipe(tap(console.log), autoComplete(this))
      .subscribe();
  }
 
  // Extra actions (optional).
  ngOnDestroy(): void {
    console.log('this.subscription$$.closed:::', this.subscription$$.closed);
  }
}

Golden rules

  • Use autoComplete always at the end of the pipe.
  • Do not implement OnDestroy if you do not need extra actions. The purpose of this library is no only to avoid memory leaks but also the unsubscription boilerplate.
  • If you use sharedReplay do not forget to set refCount to true:
obs$.pipe(shareReplay({ refCount: true }), autoComplete(this))

Recommendation

To avoid surprises it is recommended that you always use the signature that takes the config parameter in shareReplay.

If you want to make sure of that, you can use TSLint for that:

npm i -D rxjs-tslint-rules

And in your tslint.json:

{
  "extends": [
    "rxjs-tslint-rules"
  ],
  "rules": {
    "rxjs-no-sharereplay": {
      "options": [{
        "allowConfig": true
      }],
      "severity": "error"
    }
  }
}

Conclusion

You have resolved the unsubscription problem with 2 lines of code:

@Unsubscriber()
[...]
  autoComplete(this)

Happy Angular coding!

Install

npm i ngx-hocs-unsubscriber

DownloadsWeekly Downloads

9

Version

1.1.7

License

MIT

Unpacked Size

43.7 kB

Total Files

28

Last publish

Collaborators

  • avatar