A neat way to unsubscribe from observables when the component destroyed
npm install @ngneat/until-destroy
# Or if you use yarn
yarn add @ngneat/until-destroy
import { UntilDestroy, untilDestroyed } from '@ngneat/until-destroy';
@UntilDestroy()
@Component({})
export class InboxComponent {
ngOnInit() {
interval(1000)
.pipe(untilDestroyed(this))
.subscribe();
}
}
You can set the checkProperties
option to true
if you want to unsubscribe from subscriptions properties automatically:
@UntilDestroy({ checkProperties: true })
@Component({})
export class HomeComponent {
// We'll dispose it on destroy
subscription = fromEvent(document, 'mousemove').subscribe();
}
You can set the arrayName
property if you want to unsubscribe from each subscription in the specified array.
@UntilDestroy({ arrayName: 'subscriptions' })
@Component({})
export class HomeComponent {
subscriptions = [
fromEvent(document, 'click').subscribe(),
fromEvent(document, 'mousemove').subscribe()
];
// You can still use the opertator
ngOnInit() {
interval(1000).pipe(untilDestroyed(this));
}
}
@UntilDestroy()
@Injectable()
export class InboxService {
constructor() {
interval(1000)
.pipe(untilDestroyed(this))
.subscribe();
}
}
@Component({
providers: [InboxService]
})
export class InboxComponent {
constructor(inboxService: InboxService) {}
}
All options, described above, are also applicable to providers.
npm install ngx-take-until-destroy
# Or if you use yarn
yarn add ngx-take-until-destroy
import { untilDestroyed } from 'ngx-take-until-destroy';
@Component({})
export class InboxComponent implements OnDestroy {
ngOnInit() {
interval(1000)
.pipe(untilDestroyed(this))
.subscribe(val => console.log(val));
}
// This method must be present, even if empty.
ngOnDestroy() {
// To protect you, we'll throw an error if it doesn't exist.
}
}
import { untilDestroyed } from 'ngx-take-until-destroy';
export class Widget {
constructor() {
interval(1000)
.pipe(untilDestroyed(this, 'destroy'))
.subscribe(console.log);
}
// The name needs to be the same as the second parameter
destroy() {}
}
To make it easier for you to migrate, we've built a script that will update the imports path, and add the decorator for you. You need to run it manually on your project.
Thanks goes to these wonderful people (emoji key):
Netanel Basal ๐ป ๐ ๐ค |
Artur Androsovych ๐ป ๐ก ๐ค ๐ |
Krzysztof Karol ๐ |
Alex Malkevich ๐ป |
Khaled Shaaban ๐ป |
kmathy ๐ป |
This project follows the all-contributors specification. Contributions of any kind welcome!