RequestOptions
class
deprecated
Creates a request options object to be optionally provided when instantiating a Request.
Deprecated: see https://angular.io/guide/http
class RequestOptions {
constructor(opts: RequestOptionsArgs = {})
method: RequestMethod | string | null
headers: Headers | null
body: any
url: string | null
params: URLSearchParams
search: URLSearchParams
withCredentials: boolean | null
responseType: ResponseContentType | null
merge(options?: RequestOptionsArgs): RequestOptions
}
Subclasses
BaseRequestOptions
Description
This class is based on the RequestInit
description in the Fetch Spec.
All values are null by default. Typical defaults can be found in the BaseRequestOptions class, which sub-classes RequestOptions
.
import {RequestOptions, Request, RequestMethod} from '@angular/http';
const options = new RequestOptions({
method: RequestMethod.Post,
url: 'https://google.com'
});
const req = new Request(options);
console.log('req.method:', RequestMethod[req.method]); // Post
console.log('options.url:', options.url); // https://google.com
Constructor
constructor(opts: RequestOptionsArgs = {})Parameters
|
Properties
Property | Description |
---|---|
string | null | Http method with which to execute a Request. Acceptable methods are defined in the RequestMethod enum. |
null | |
body: any
|
Body to be used when creating a Request. |
null | Url with which to perform a Request. |
params: URLSearchParams
|
Search parameters to be included in a Request. |
search: URLSearchParams
|
|
null | Enable use credentials for a Request. |
null |
Methods
merge() | |||
---|---|---|---|
Creates a copy of the RequestOptions 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?: RequestOptionsArgs): RequestOptionsParameters
Returns
| |||
Note that
|
© 2010–2019 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v7.angular.io/api/http/RequestOptions