W3cubDocs

/Angular 2 TypeScript

Request

Experimental Class

Class Overview

class Request extends Body {
  constructor(requestOptions: RequestArgs)
  
  
  method : RequestMethod
  headers : Headers
  url : string
  withCredentials : boolean
  responseType : ResponseContentType
  detectContentType() : ContentType
  detectContentTypeFromBody() : ContentType
  getBody() : any
}

Class Description

Creates Request instances from provided values.

The Request's interface is inspired by the Request constructor defined in the Fetch Spec, but is considered a static value whose body can be accessed many times. There are other differences in the implementation, but this is the most significant.

Request instances are typically created by higher-level classes, like Http and Jsonp, but it may occasionally be useful to explicitly create Request instances. One such example is when creating services that wrap higher-level services, like Http, where it may be useful to generate a Request with arbitrary headers and search params.

import {Injectable, Injector} from '@angular/core';
import {HTTP_PROVIDERS, Http, Request, RequestMethod} from '@angular/http';

@Injectable()
class AutoAuthenticator {
  constructor(public http:Http) {}
  request(url:string) {
    return this.http.request(new Request({
      method: RequestMethod.Get,
      url: url,
      search: 'password=123'
    }));
  }
}

var injector = Injector.resolveAndCreate([HTTP_PROVIDERS, AutoAuthenticator]);
var authenticator = injector.get(AutoAuthenticator);
authenticator.request('people.json').subscribe(res => {
  //URL should have included '?password=123'
  console.log('people', res.json());
});

Constructor

constructor(requestOptions: RequestArgs)

Class Details

method : RequestMethod

Http method with which to perform the request.

headers : Headers

Headers instance

url : string

Url of the remote resource

withCredentials : boolean

Enable use credentials

responseType : ResponseContentType

Buffer to store the response

detectContentType() : ContentType

Returns the content type enum based on header options.

detectContentTypeFromBody() : ContentType

Returns the content type of request's body based on its type.

getBody() : any

Returns the request's body according to its type. If body is undefined, return null.

exported from @angular/http/index, defined in @angular/http/src/static_request.ts

© 2010–2017 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v2.angular.io/docs/ts/latest/api/http/index/Request-class.html