This is the archived documentation for Angular v6. Please visit angular.io to see documentation for the current version of Angular.
API > @angular/http

ResponseOptions

Creates a response options object to be optionally provided when instantiating a Response.

See more...

Deprecated: see https://angular.io/guide/http

      
      class ResponseOptions {
  constructor(opts: ResponseOptionsArgs = {})
  body: string | Object | ArrayBuffer | Blob | null
  status: number | null
  headers: Headers | null
  url: string | null
  merge(options?: ResponseOptionsArgs): ResponseOptions
}

Subclasses

Description

This class is based on the ResponseInit description in the Fetch Spec.

All values are null by default. Typical defaults can be found in the BaseResponseOptions class, which sub-classes ResponseOptions.

This class may be used in tests to build Responses for mock responses (see MockBackend).

Constructor

constructor(opts: ResponseOptionsArgs = {})
      
      constructor(opts: ResponseOptionsArgs = {})

Parameters

opts

Type: ResponseOptionsArgs.

Optional. Default is {}.

Properties

Property Description
body: string | Object | ArrayBuffer | Blob | null

String, Object, ArrayBuffer or Blob representing the body of the Response.
status: number | null

Http status code associated with the response.
headers: Headers | null

Response headers
url: string | null

Methods

merge()

Creates a copy of the ResponseOptions instance, using the optional input as values to override existing values. This method will not change the values of the instance on which it is being called.

 
      
      merge(options?: ResponseOptionsArgs): ResponseOptions

Parameters

options

Type: ResponseOptionsArgs.

Optional. Default is undefined.

Returns

ResponseOptions

This may be useful when sharing a base ResponseOptions object inside tests, where certain properties may change from test to test.

Example

import {ResponseOptions, Response} from '@angular/http'; var options = new ResponseOptions({ body: {name: 'Jeff'} }); var res = new Response(options.merge({ url: 'https://google.com' })); console.log('options.url:', options.url); // null console.log('res.json():', res.json()); // Object {name: "Jeff"} console.log('res.url:', res.url); // https://google.com 
      
      import {ResponseOptions, Response} from '@angular/http';

var options = new ResponseOptions({
  body: {name: 'Jeff'}
});
var res = new Response(options.merge({
  url: 'https://google.com'
}));
console.log('options.url:', options.url); // null
console.log('res.json():', res.json()); // Object {name: "Jeff"}
console.log('res.url:', res.url); // https://google.com

Usage notes

Example

import {ResponseOptions, Response} from '@angular/http'; var options = new ResponseOptions({ body: '{"name":"Jeff"}' }); var res = new Response(options); console.log('res.json():', res.json()); // Object {name: "Jeff"} 
      
      import {ResponseOptions, Response} from '@angular/http';

var options = new ResponseOptions({
  body: '{"name":"Jeff"}'
});
var res = new Response(options);

console.log('res.json():', res.json()); // Object {name: "Jeff"}