HttpAdapter | @inetsoft/api-client

Interface for classes that provide an adapter to an HTTP client implementation.

Type parameters

R

Hierarchy

HttpAdapter

Index

Methods

Methods

delete

delete(url: string, params?: undefined | object, headers?: undefined | object): Promise<R>

- Defined in client/http-adapter.ts:68
Executes an HTTP GET request.

Parameters
- url: string
  
  the URL.
- Optional params: undefined | object
  
  the request query parameters, if any.uest headers, if any.
- Optional headers: undefined | object
  
  the HTTP req
Returns Promise<R>

the HTTP response body.

get

get(url: string, params?: undefined | object, headers?: undefined | object): Promise<R>

- Defined in client/http-adapter.ts:30
Executes an HTTP GET request.

Parameters
- url: string
  
  the URL.
- Optional params: undefined | object
  
  the request query parameters, if any.
- Optional headers: undefined | object
  
  the HTTP request headers, if any.
Returns Promise<R>

the HTTP response body.

map

map<T>(response: Promise<R>): Promise<T>

- Defined in client/http-adapter.ts:78
Maps an HTTP response body onto a JSON type.

Type parameters
- T
Parameters
- response: Promise<R>
  
  the HTTP response object.
Returns Promise<T>

the HTTP response body.

mapBinary

mapBinary(response: Promise<R>): Promise<ArrayBuffer>

- Defined in client/http-adapter.ts:96
Maps an HTTP response body onto raw, binary data.

Parameters
- response: Promise<R>
  
  the HTTP response object.
Returns Promise<ArrayBuffer>

the HTTP response body.

mapText

mapText(response: Promise<R>): Promise<string>

- Defined in client/http-adapter.ts:87
Maps an HTTP response body onto plain text.

Parameters
- response: Promise<R>
  
  the HTTP response object.
Returns Promise<string>

the HTTP response body.

post

post(url: string, body?: any, params?: undefined | object, headers?: undefined | object): Promise<R>

- Defined in client/http-adapter.ts:43
Executes an HTTP POST request.

Parameters
- url: string
  
  the URL.
- Optional body: any
  
  the HTTP request body.
- Optional params: undefined | object
  
  the request query parameters, if any.
- Optional headers: undefined | object
  
  the HTTP request headers, if any.
Returns Promise<R>

the HTTP response body.

put

put(url: string, body?: any, params?: undefined | object, headers?: undefined | object): Promise<R>

- Defined in client/http-adapter.ts:56
Executes an HTTP PUT request.

Parameters
- url: string
  
  the URL.
- Optional body: any
  
  the HTTP request body.
- Optional params: undefined | object
  
  the request query parameters, if any.
- Optional headers: undefined | object
  
  the HTTP request headers, if any.
Returns Promise<R>

the HTTP response body.

Generated using TypeDoc