How to cancel a HTTPRequest in Angular 2?

Question

I know how to reject the request promise only.

return new Promise((resolve, reject) => {
    this.currentLoading.set(url, {resolve, reject});

    this.http.get(url, {headers: reqHeaders})
        .subscribe(
            (res) => {
                res = res.json();

                this.currentLoading.delete(url);
                this.cache.set(url, res);

                resolve(res);
            }
        );
});

score 87 · Answer 1 · edited Feb 24 '20 at 13:49

87

You can use the following simple solution:

if ( this.subscription ) {
   this.subscription.unsubscribe();
}
this.subscription = this.http.get( 'awesomeApi' )
 .subscribe((res)=> {
  // your awesome code..
})

edited Feb 24 '20 at 13:49

rostamiani

2,131
5
28
62

answered Oct 20 '16 at 09:23

ErvTheDev

4,117
2
15
19

3

works great with Angular 2.4.6 - This should be the accepted answer – Michail Michailidis Mar 12 '17 at 10:14
3

Is it possible to be done via `.toPromise()` method and `then()`, `catch()`? – Saeed Neamati Jun 17 '17 at 17:43
1

@SaeedNeamati why do you need to be done via promise ? – ErvTheDev Jun 19 '17 at 08:13
2

what is the type of this.subscription?? – Sunil Garg Sep 26 '17 at 16:57
@SunilGarg are you asking for subscription: Subscription; ? – ErvTheDev Sep 26 '17 at 19:08
I declared `subscription:Subscriber` but this is showing error, what should be the type of `this.subscription` – Sunil Garg Sep 27 '17 at 06:00
Maaan use a switchMap :D – Feb 20 '19 at 09:18
1

Typo of this.subscription is Subscription from rxJs. I would correct first line to `if ( this.subscription && !this.subscription.closed ) {` to check if it was already been unsubscribed – Nebojsha Aug 14 '19 at 15:38
This solution seems to be just canceling the subscription to the observable, but if the httpRequest was sent and process by the API is not really canceling the request, just the reaction - is there a way to cancel the request before if finishes – Mauricio Gracia Gutierrez Jan 06 '22 at 02:05
1

@MauricioGraciaGutierrez Can you tell me more about your use case? Do you need this for large file uploads? – ErvTheDev Jan 06 '22 at 16:02
I basically want to cancer the request before it finishes - I have mentioned a specific case here but is as i have mentioned - https://stackoverflow.com/questions/70601775/how-to-cancel-an-httpclient-delete-request-before-it-finishes – Mauricio Gracia Gutierrez Jan 06 '22 at 19:33

TGH · Accepted Answer · 2020-05-08T11:44:43.983

81

You can call unsubscribe

let sub = this.http.get(url, {headers: reqHeaders})
            .subscribe(
                (res) => {
                    res = res.json();

                    this.currentLoading.delete(url);
                    this.cache.set(url, res);

                    resolve(res);
                }
            );

sub.unsubscribe();

More info here: http://www.syntaxsuccess.com/viewarticle/angular-2.0-and-http

edited May 08 '20 at 11:44

answered Apr 08 '16 at 03:30

TGH

37,937
11
96
131

1

This answer is not longer valid in beta.15. There is no `unsubscribe` method in Observable now. – tom10271 Apr 25 '16 at 07:52
1

`unsubscribe` was replaced by `dispose`. – Menello Jun 10 '16 at 15:19
2

I'm using RC.5 of Angular2, and `unsubscribe` is present (version 5.0.0-beta.6 of rxjs). Perhaps it was restored since the comments were made? Not sure where the discrepancy is coming from. – Dawson Toth Aug 18 '16 at 15:12
@DawsonToth Angular 2 team hasn't updated rxjs from a long time, it will be updated in RC6 – Godfather Aug 26 '16 at 18:18
could somebody provide a live example and we close the question about `unsubscribe ` / `dispose ` – Stepan Suvorov Sep 14 '16 at 06:45
1

What is unsubscribing all of a sudden stops cancelling the request? What can be the problem? – Bruno Santos Feb 12 '19 at 21:18
This is actually not correct. The service will unsubscribe before it even completes. Not sure why this was marked as correct answer by so many. – GeoRover May 06 '20 at 20:52

score 10 · Answer 3 · answered Jan 30 '18 at 13:42

10

You can use SwitchMap on the observable which will cancel any previous request's responses and only request the latest:

https://www.learnrxjs.io/operators/transformation/switchmap.html

answered Jan 30 '18 at 13:42

Ben Taliadoros

6,649
15
59
90

1

How? Can you give us an example? – A. Morel May 25 '18 at 08:09
Example here: https://angular-2-training-book.rangle.io/handout/http/search_with_switchmap.html – Ben Taliadoros May 29 '18 at 12:47

score 6 · Answer 4 · answered Aug 03 '17 at 09:57

A little late for the party, but here is my take:

import { Injectable } from '@angular/core'
import { Http } from '@angular/http'
import { Observable } from 'rxjs/Observable'
import { Subscriber } from 'rxjs/Subscriber'

@Injectable ()
export class SomeHttpServiceService {
  private subscriber: Subscriber<any>
  constructor(private http: Http){ }

  public cancelableRequest() {
    let o = new Observable(obs => subscriber = obs)
    return this.http.get('someurl').takeUntil(o)
      .toPromise() //I dont like observables
      .then(res => {
        o.unsubscribe
        return res
      })
  }
  public cancelRequest() {
    subscriber.error('whatever')
  }
}

This allows you to manually cancel a request. I sometimes end up with an observable or promise that will make changes to a result on the page. If the request was initiated automatically (user didn't type anyting in a field for x millis) being able to abort the request is nice (user is suddenly typing something again)...

takeUntil should also work with a simple timeout (Observable.timer) if that is what you are looking for https://www.learnrxjs.io/operators/filtering/takeuntil.html

Why don't u like observables? For http it is the same like promise, but also has error and complete — Mick, Aug 31 '17 at 12:57
@Mick, I think clearfix was just accommodating the OP's preference for promises, not expressing his/her opinion. #theSpiritOfStackOverflow — Rap, Nov 10 '17 at 15:53

score 3 · Answer 5 · edited Nov 25 '19 at 13:12

3

Use switchMap [docs], which will cancel all in-flight requests and use only the latest.

get(endpoint: string): Observable<any> {
        const headers: Observable<{url: string, headers: HttpHeaders}> = this.getConfig();
        return headers.pipe(
            switchMap(obj => this.http.get(`${obj.url}${endpoint}`, { headers: obj.headers, params: params }) ),
            shareReplay(1)
        );
    }

shareReplay will emit the latest value for any late subscribers.

edited Nov 25 '19 at 13:12

Bjorn 'Bjeaurn' S

3,691
2
16
26

answered May 21 '19 at 11:28

Ian

2,512
1
20
26

2

how to do it if I do't have any observable link your `headers`. I have http call made on click of button but from the docs, I can only use `switchMap` on observable – rainversion_3 Mar 04 '20 at 15:04

score 1 · Answer 6 · answered Dec 30 '21 at 23:34

This is a great thread, and I have a little more info to provide. I have an API call that could potentially go on for a very long time. So I needed the previous request to cancel with a timeout. I just figured out today that I can add a timeout operator to the pipe function. Once the timeout completes its count, that will cancel the previous HTTP request.

Example...

return this.exampleHttpRequest()
  .pipe(
    timeout(3000),
    catchError(err => console.log(error)
)

How to cancel a HTTPRequest in Angular 2?

6 Answers6

Linked