[RxJS] Use finalize for side effects on completion
Calling
.unsubscribe()
will NOT triggercomplete
callback!
const sub = interval(1000).subscribe({
next: (val: any) => {
counter.innerHTML = val;
},
complete: () => {
counter.innerHTML = 'Stopped!' // <-- in this case, it won't run
}
});
// calling unsubscribe will not trigger complete callbacks
setTimeout(() => {
sub.unsubscribe();
}, 2000);
If you use take, takeUntil...
those will trigger complete
callback
// operators that complete observables will, like take and takeUntil
interval(1000).pipe(
takeUntil(click$)
).subscribe({
next: (val: any) => {
counter.innerHTML = val;
},
complete: () => {
counter.innerHTML = 'Stopped!' // <-- will run
}
});
Use finalize
/*
* You can also use finalize, which lets you run a function
* on completion of the observable. This is good for misc side-effects,
* but note, like tap, does not actually emit a returned item.
*
* If you need to emit a final value on completion you can use
* the endWith operator instead.
*/
interval(1000).pipe(
takeUntil(click$),
finalize(() => counter.innerHTML = 'Stopped!')
).subscribe((val: any) => counter.innerHTML = val);
works with throwError
:
/*
* finalize function will also be called if an error
* occurs.
*/
throwError(new Error('Oops!')).pipe(
takeUntil(click$),
finalize(() => counter.innerHTML = 'Stopped!')
).subscribe((val: any) => counter.innerHTML = val);