TestRequest

class

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

class TestRequest {
  constructor(request: HttpRequest<any>, observer: Observer<HttpEvent<any>>)
  cancelled: boolean
  request: HttpRequest<any>
  flush(body: ArrayBuffer | Blob | string | number | Object | (string | number | Object | null)[] | null, opts: {...}): void
  error(error: ErrorEvent, opts: {...}): 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	Type: `HttpRequest`.
observer	Type: `Observer>`.

Properties

Property	Description
`cancelled: boolean`	Read-only. Whether the request was cancelled after it was sent.
`request: HttpRequest<any>`	Declared in constructor.

Methods

flush()

Resolve the request by returning a body plus additional HTTP information (such as response headers) if provided.

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

Parameters

body

opts

Type: { headers?: HttpHeaders | { [name: string]: string | string[]; }; status?: number; statusText?: string; }.

Optional. Default is {}.

Returns

void

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

error()

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

`error(error: ErrorEvent, opts: { headers?: HttpHeaders | { [name: string]: string | string[]; }; status?: number; statusText?: string; } = {}): void`

Parameters

error

Type: ErrorEvent.

opts

Type: { headers?: HttpHeaders | { [name: string]: string | string[]; }; status?: number; statusText?: string; }.

Optional. Default is {}.

Returns

void

event()

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

`event(event: HttpEvent<any>): void`

Parameters

event

Type: HttpEvent.

Returns

void

© 2010–2019 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v6.angular.io/api/common/http/testing/TestRequest