Cookies concent notice

This site uses cookies from Google to deliver its services and to analyze traffic.
Learn more
Skip to main content
This site is no longer updated.Head to Angular.devHome
/

This is the archived documentation for Angular v17. Please visit angular.dev to see this page for the current version of Angular.

TestRequest

A mock requests that was received and is ready to be answered.

See more...

      
      class TestRequest {
  constructor(request: HttpRequest<any>, observer: Observer<HttpEvent<any>>)
  cancelled: boolean
  request: HttpRequest<any>
flush(body: string | number | boolean | Object | ArrayBuffer | Blob | (string | number | boolean | Object)[], opts: { headers?: HttpHeaders | { [name: string]: string | string[]; }; status?: number; statusText?: string; } = {}): void
error(error: ErrorEvent | ProgressEvent<EventTarget>, opts: TestRequestErrorOptions = {}): void
error(error: ErrorEvent, opts?: TestRequestErrorOptions): void
error(error: ProgressEvent<EventTarget>, opts?: TestRequestErrorOptions): void
event(event: HttpEvent<any>): void }

Description

This interface allows access to the underlying HttpRequest, and allows responding with HttpEvents or HttpErrorResponses.

Constructor

      
      constructor(request: HttpRequest<any>, observer: Observer<HttpEvent<any>>)
    
Parameters
request HttpRequest<any>
observer Observer<HttpEvent<any>>

Properties

Property Description
cancelled: boolean Read-Only

Whether the request was cancelled after it was sent.

request: HttpRequest<any> Declared in Constructor

Methods

Resolve the request by returning a body plus additional HTTP information (such as response headers) if provided. If the request specifies an expected body type, the body is converted into the requested type. Otherwise, the body is converted to JSON by default.

      
      flush(body: string | number | boolean | Object | ArrayBuffer | Blob | (string | number | boolean | Object)[], opts: { headers?: HttpHeaders | { [name: string]: string | string[]; }; status?: number; statusText?: string; } = {}): void
    
Parameters
body string | number | boolean | Object | ArrayBuffer | Blob | (string | number | boolean | Object)[]
opts object

Optional. Default is {}.

Returns

void

Both successful and unsuccessful responses can be delivered via flush().

Resolve the request by returning an ErrorEvent (e.g. simulating a network failure).

      
      error(error: ErrorEvent, opts?: TestRequestErrorOptions): void
    

Deprecated Http requests never emit an ErrorEvent. Please specify a ProgressEvent.

Parameters
error ErrorEvent
opts TestRequestErrorOptions

Optional. Default is undefined.

Returns

void

Resolve the request by returning an ProgressEvent (e.g. simulating a network failure).

      
      error(error: ProgressEvent<EventTarget>, opts?: TestRequestErrorOptions): void
    
Parameters
error ProgressEvent<EventTarget>
opts TestRequestErrorOptions

Optional. Default is undefined.

Returns

void

Deliver an arbitrary HttpEvent (such as a progress event) on the response stream for this request.

      
      event(event: HttpEvent<any>): void
    
Parameters
event HttpEvent<any>
Returns

void