Function request

request(
resource: RequestInput,
options?: RequestOptions,
): Promise<MaybeResult<Response, RequestErrors>>
HTTP Request
Parameters
- resource: RequestInput
- options: RequestOptions = {}
Returns Promise<MaybeResult<Response, RequestErrors>>
- Defined in http.js:307

Index

Methods

delete get head json options patch post put trace

Methods

delete

delete(
resource: RequestInput,
options?: RequestOptions,
): Promise<MaybeResult<Response, RequestErrors>>
Request DELETE
Parameters
- resource: RequestInput
- options: RequestOptions = {}
Returns Promise<MaybeResult<Response, RequestErrors>>
- Defined in http.js:727

get

get(
resource: RequestInput,
options?: RequestOptions,
): Promise<MaybeResult<Response, RequestErrors>>
Request GET
Parameters
- resource: RequestInput
- options: RequestOptions = {}
Returns Promise<MaybeResult<Response, RequestErrors>>
- Defined in http.js:694

head

head(
resource: RequestInput,
options?: RequestOptions,
): Promise<MaybeResult<Response, RequestErrors>>
Request HEAD
Parameters
- resource: RequestInput
- options: RequestOptions = {}
Returns Promise<MaybeResult<Response, RequestErrors>>
- Defined in http.js:749

json

json<T>(
resource: RequestInput,
options?: JSONRequestOptions<T>,
): Promise<MaybeResult<T, RequestJsonErrors>>
Request Json GET
Type Parameters
- T
Parameters
- resource: RequestInput
- options: JSONRequestOptions<T> = {}
Returns Promise<MaybeResult<T, RequestJsonErrors>>
- Defined in http.js:783

delete

delete<T>(
resource: RequestInput,
options?: JSONRequestOptions<T>,
): Promise<MaybeResult<T, RequestJsonErrors>>
Request Json DELETE
Type Parameters
- T
Parameters
- resource: RequestInput
- options: JSONRequestOptions<T> = {}
Returns Promise<MaybeResult<T, RequestJsonErrors>>
- Defined in http.js:918

get

get<T>(
resource: RequestInput,
options?: JSONRequestOptions<T>,
): Promise<MaybeResult<T, RequestJsonErrors>>
Request Json GET
Type Parameters
- T
Parameters
- resource: RequestInput
- options: JSONRequestOptions<T> = {}
Returns Promise<MaybeResult<T, RequestJsonErrors>>
- Defined in http.js:882

options

options<T>(
resource: RequestInput,
options?: JSONRequestOptions<T>,
): Promise<MaybeResult<T, RequestJsonErrors>>
Request Json OPTIONS
Type Parameters
- T
Parameters
- resource: RequestInput
- options: JSONRequestOptions<T> = {}
Returns Promise<MaybeResult<T, RequestJsonErrors>>
- Defined in http.js:942

patch

patch<T>(
resource: RequestInput,
options?: JSONRequestOptions<T>,
): Promise<MaybeResult<T, RequestJsonErrors>>
Request Json PATCH
Type Parameters
- T
Parameters
- resource: RequestInput
- options: JSONRequestOptions<T> = {}
Returns Promise<MaybeResult<T, RequestJsonErrors>>
- Defined in http.js:930

post

post<T>(
resource: RequestInput,
options?: JSONRequestOptions<T>,
): Promise<MaybeResult<T, RequestJsonErrors>>
Request Json POST
Type Parameters
- T
Parameters
- resource: RequestInput
- options: JSONRequestOptions<T> = {}
Returns Promise<MaybeResult<T, RequestJsonErrors>>
- Defined in http.js:894

put

put<T>(
resource: RequestInput,
options?: JSONRequestOptions<T>,
): Promise<MaybeResult<T, RequestJsonErrors>>
Request Json PUT
Type Parameters
- T
Parameters
- resource: RequestInput
- options: JSONRequestOptions<T> = {}
Returns Promise<MaybeResult<T, RequestJsonErrors>>
- Defined in http.js:906

trace

trace<T>(
resource: RequestInput,
options?: JSONRequestOptions<T>,
): Promise<MaybeResult<T, RequestJsonErrors>>
Request Json TRACE
Type Parameters
- T
Parameters
- resource: RequestInput
- options: JSONRequestOptions<T> = {}
Returns Promise<MaybeResult<T, RequestJsonErrors>>
- Defined in http.js:954

options

options(
resource: RequestInput,
options?: RequestOptions,
): Promise<MaybeResult<Response, RequestErrors>>
Request OPTIONS
Parameters
- resource: RequestInput
- options: RequestOptions = {}
Returns Promise<MaybeResult<Response, RequestErrors>>
- Defined in http.js:760

patch

patch(
resource: RequestInput,
options?: RequestOptions,
): Promise<MaybeResult<Response, RequestErrors>>
Request PATCH
Parameters
- resource: RequestInput
- options: RequestOptions = {}
Returns Promise<MaybeResult<Response, RequestErrors>>
- Defined in http.js:738

post

post(
resource: RequestInput,
options?: RequestOptions,
): Promise<MaybeResult<Response, RequestErrors>>
Request POST
Parameters
- resource: RequestInput
- options: RequestOptions = {}
Returns Promise<MaybeResult<Response, RequestErrors>>
- Defined in http.js:705

put

put(
resource: RequestInput,
options?: RequestOptions,
): Promise<MaybeResult<Response, RequestErrors>>
Request PUT
Parameters
- resource: RequestInput
- options: RequestOptions = {}
Returns Promise<MaybeResult<Response, RequestErrors>>
- Defined in http.js:716

trace

trace(
resource: RequestInput,
options?: RequestOptions,
): Promise<MaybeResult<Response, RequestErrors>>
Request TRACE
Parameters
- resource: RequestInput
- options: RequestOptions = {}
Returns Promise<MaybeResult<Response, RequestErrors>>
- Defined in http.js:771