Awesome
<h1 align="center"> @badisi/ngx-safe-subscribe </h1> <p align="center"> <i>⛑️ Automatically unsubscribe from RxJS observables in Angular components.</i><br/> </p> <p align="center"> <a href="https://www.npmjs.com/package/@badisi/ngx-safe-subscribe"> <img src="https://img.shields.io/npm/v/@badisi/ngx-safe-subscribe?color=blue&logo=npm" alt="npm version" /></a> <a href="https://npmcharts.com/compare/@badisi/ngx-safe-subscribe?minimal=true"> <img src="https://img.shields.io/npm/dw/@badisi/ngx-safe-subscribe.svg?color=7986CB&logo=npm" alt="npm donwloads" /></a> <a href="https://github.com/Badisi/ngx-safe-subscribe/blob/main/LICENSE"> <img src="https://img.shields.io/npm/l/@badisi/ngx-safe-subscribe.svg?color=ff69b4" alt="license" /></a> </p> <p align="center"> <a href="https://github.com/Badisi/ngx-safe-subscribe/actions/workflows/ci_tests.yml"> <img src="https://github.com/Badisi/ngx-safe-subscribe/actions/workflows/ci_tests.yml/badge.svg" alt="build status" /></a> <a href="https://github.com/badisi/ngx-safe-subscribe/blob/main/CONTRIBUTING.md#-submitting-a-pull-request-pr"> <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome" /></a> </p> <hr/>:zap: Angular <= 13 version available here
:zap: RxJS 5.x version available here
<hr/>Installation
npm install @badisi/ngx-safe-subscribe --save
yarn add @badisi/ngx-safe-subscribe
Usage
SafeSubscribe is an augmentation method of Observable.
Calling safeSubscribe
instead of subscribe
will automatically unsubscribe your observable at component destroy.
Example with Angular components
import { Component, OnInit } from '@angular/core';
import { SafeSubscribe } from '@badisi/ngx-safe-subscribe';
import { interval } from 'rxjs';
@SafeSubscribe()
@Component({
selector: 'app-component'
})
export class AppComponent implements OnInit {
ngOnInit() {
interval(1000).safeSubscribe(this, () => {
console.log('This log will stop on component destroy.')
});
}
}
Example with simple class objects
import { SafeSubscribe } from '@badisi/ngx-safe-subscribe';
import { interval } from 'rxjs';
@SafeSubscribe('destroy')
export class MyObject {
constructor() {
interval(1000).safeSubscribe(this, () => {
console.log('This log will stop on object destroy.')
});
}
destroy() {}
}
Api
@SafeSubscribe(destructorName)
Arguments
destructorName: string
(default: "ngOnDestroy") - The name of the method that will be called when the object is supposed to be destroyed.
Observable.safeSubscribe(target, ...arguments): Subscription
Arguments
target: any
- A reference to the object that is holding the observable.observerOrNext?: Observer|Function
- Either an observer with methods to be called, or the first of three possible handlers, which is the handler for each value emitted from the subscribed Observable.error?: Function
- A handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown asynchronously as unhandled.complete?: Function
- A handler for a terminal event resulting from successful completion.
Return
- A
Subscription
reference to the registered handler.
Purpose
To quote a great article from Netanel Basal :
When you subscribe to an observable or event in JavaScript, you usually need to unsubscribe at a certain point to release memory in the system. Otherwise, you will have a memory leak.
When subscribing to an observable in an Angular component, you almost always arrange to unsubscribe when the component is destroyed.
But it can quickly become a mess to deal with all those subscriptions and make sure they were properly released.
The idea behind SafeSubscribe is to abstract all the unsubscribe boilerplate and make it easier to use.
Rule of thumb
There are a few exceptional observables where you don't need to unsubscribe :
Async pipe
@HostListener
HTTP requests
Finite observables (such as Observable.timer)
However, as stated in the official Angular documentation :
Feel free to unsubscribe anyway. It is harmless and never a bad practice !
Contributing
> Want to Help ?
Want to file a bug, contribute some code or improve documentation ? Excellent!
But please read up first on the guidelines for contributing, and learn about submission process, coding rules and more.
> Code of Conduct
Please read and follow the Code of Conduct and help me keep this project open and inclusive.