Class Overview
class RequestOptions {
constructor
({method, headers, body, url, search, params, withCredentials, responseType}?: RequestOptionsArgs)
method
: RequestMethod|string
headers
: Headers
body
: any
url
: string
params
: URLSearchParams
search
: URLSearchParams
withCredentials
: boolean
responseType
: ResponseContentType
merge
(options?: RequestOptionsArgs) : RequestOptions
}
Class Description
Creates a request options object to be optionally provided when instantiating a
Request
.
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
.
Example (live demo)
Constructor
Class Details
method : RequestMethod|string
Http method with which to execute a Request
.
Acceptable methods are defined in the RequestMethod
enum.
headers : Headers
Headers
to be attached to a Request
.
body : any
Body to be used when creating a Request
.
url : string
Url with which to perform a Request
.
params : URLSearchParams
Search parameters to be included in a Request
.
search : URLSearchParams
withCredentials : boolean
Enable use credentials for a Request
.
responseType : ResponseContentType
merge(options?: RequestOptionsArgs) : RequestOptions
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.
Note that headers
and search
will override existing values completely if present in
the options
object. If these values should be merged, it should be done prior to calling
merge
on the RequestOptions
instance.
exported from http/index, defined in http/src/base_request_options.ts