XhrHttpClient | @michaelcoxon/rest-client

Implementation of IHttpClient for XMLHttpRequest

Hierarchy

XhrHttpClient

Implements

IHttpClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new XhrHttpClient(): XhrHttpClient
new XhrHttpClient(filters: IHttpFilter[]): XhrHttpClient
new XhrHttpClient(filters: IHttpFilter[], headers: IHttpRequestHeaderCollection): XhrHttpClient
new XhrHttpClient(filters: IHttpFilter[], headers: IHttpRequestHeaderCollection, ignoreCache: boolean): XhrHttpClient
new XhrHttpClient(filters: IHttpFilter[], headers: IHttpRequestHeaderCollection, ignoreCache: boolean, timeout: number): XhrHttpClient
new XhrHttpClient(filters?: IHttpFilter[], headers?: IHttpRequestHeaderCollection, ignoreCache?: undefined | false | true, timeout?: undefined | number): XhrHttpClient

- Defined in src/xhr/XhrHttpClient.ts:28
default constructor

Returns XhrHttpClient
- Defined in src/xhr/XhrHttpClient.ts:31
constructor

Parameters
- filters: IHttpFilter[]
  
  filters for the request/response
Returns XhrHttpClient
- Defined in src/xhr/XhrHttpClient.ts:36
constructor

Parameters
- filters: IHttpFilter[]
  
  filters for the request/response
- headers: IHttpRequestHeaderCollection
  
  headers for the request
Returns XhrHttpClient
- Defined in src/xhr/XhrHttpClient.ts:42
constructor

Parameters
- filters: IHttpFilter[]
  
  filters for the request/response
- headers: IHttpRequestHeaderCollection
  
  headers for the request
- ignoreCache: boolean
  
  the ignore cache setting. true means we will always get a new value, false means we will respect the servers cache settings.
Returns XhrHttpClient
- Defined in src/xhr/XhrHttpClient.ts:49
constructor

Parameters
- filters: IHttpFilter[]
  
  filters for the request/response
- headers: IHttpRequestHeaderCollection
  
  headers for the request
- ignoreCache: boolean
  
  the ignore cache setting. true means we will always get a new value, false means we will respect the servers cache settings.
- timeout: number
  
  the timeout for the request
Returns XhrHttpClient
- Defined in src/xhr/XhrHttpClient.ts:57
constructor

Parameters
- Optional filters: IHttpFilter[]
  
  filters for the request/response
- Optional headers: IHttpRequestHeaderCollection
  
  headers for the request
- Optional ignoreCache: undefined | false | true
  
  the ignore cache setting. true means we will always get a new value, false means we will respect the servers cache settings.
- Optional timeout: undefined | number
  
  the timeout for the request
Returns XhrHttpClient

Properties

Private _headers

_headers: IHttpRequestHeaderCollection

Private _ignoreCache

_ignoreCache: boolean

Private _timeout

_timeout: number

filters

filters: IHttpFilter[]

Collections of filters to use for the request/response

Static DefaultHeaders

DefaultHeaders: IHttpRequestHeaderCollection = new HttpRequestHeaderCollection(...[{name: KnownHeaderNames.accept,value: "application/json, text/javascript, text/plain"}])

The default headers to use. defaults to Accept: application/json, text/javascript, text/plain

Static DefaultIgnoreCache

DefaultIgnoreCache: boolean = false

The default ignoreCache parameter for XHR. default is false

Static DefaultTimeout

DefaultTimeout: number = 5000

The default timeout for requests. default is 5000ms

Methods

createRequest

createRequest(method: HttpMethod, uri: string): IHttpRequest
createRequest(method: HttpMethod, uri: Url): IHttpRequest
createRequest(method: HttpMethod, uri: StringOrUrl): IHttpRequest

- Defined in src/xhr/XhrHttpClient.ts:78
Creates a new request

Parameters
- method: HttpMethod
  
  the HTTP method to use
- uri: string
  
  the resource uri
Returns IHttpRequest
Implementation of IHttpClient.createRequest
- Defined in src/xhr/XhrHttpClient.ts:84
Creates a new request

Parameters
- method: HttpMethod
  
  the HTTP method to use
- uri: Url
  
  the resource uri
Returns IHttpRequest
Implementation of IHttpClient.createRequest
- Defined in src/xhr/XhrHttpClient.ts:90
Creates a new request

Parameters
- method: HttpMethod
  
  the HTTP method to use
- uri: StringOrUrl
  
  the resource uri
Returns IHttpRequest

getObjectAsync

getObjectAsync<T>(uri: string): Promise<T>
getObjectAsync<T>(uri: Url): Promise<T>
getObjectAsync<T>(uri: StringOrUrl): Promise<T>

- Defined in src/xhr/XhrHttpClient.ts:101
Performs a get request to a JSON returning source and casts the object

throws

RequestCancelledException when the request is cancelled

throws

ServiceException if the response is cancelled or if there was a status code in the error range

Type parameters
- T
Parameters
- uri: string
  
  as string
Returns Promise<T>
Implementation of IHttpClient.getObjectAsync
- Defined in src/xhr/XhrHttpClient.ts:108
Performs a get request to a JSON returning source and casts the object

throws

RequestCancelledException when the request is cancelled

throws

ServiceException if the response is cancelled or if there was a status code in the error range

Type parameters
- T
Parameters
- uri: Url
  
  as Uri
Returns Promise<T>
Implementation of IHttpClient.getObjectAsync
- Defined in src/xhr/XhrHttpClient.ts:115
Performs a get request to a JSON returning source and casts the object

throws

RequestCancelledException when the request is cancelled

throws

ServiceException if the response is cancelled or if there was a status code in the error range

Type parameters
- T
Parameters
- uri: StringOrUrl
  
  as string or Uri
Returns Promise<T>

postObjectAsync

postObjectAsync<TData, TResponseData>(uri: string, data: TData): Promise<TResponseData>
postObjectAsync<TData, TResponseData>(uri: Url, data: TData): Promise<TResponseData>
postObjectAsync<TData, TResponseData>(uri: StringOrUrl, data: TData): Promise<TResponseData>

- Defined in src/xhr/XhrHttpClient.ts:141
Performs a post request to a JSON returning source and casts the object

throws

RequestCancelledException when the request is cancelled

throws

ServiceException if the response is cancelled or if there was a status code in the error range

Type parameters
- TData
- TResponseData
Parameters
- uri: string
  
  as string
- data: TData
Returns Promise<TResponseData>
- Defined in src/xhr/XhrHttpClient.ts:148
Performs a post request to a JSON returning source and casts the object

throws

RequestCancelledException when the request is cancelled

throws

ServiceException if the response is cancelled or if there was a status code in the error range

Type parameters
- TData
- TResponseData
Parameters
- uri: Url
  
  as Uri
- data: TData
Returns Promise<TResponseData>
- Defined in src/xhr/XhrHttpClient.ts:155
Performs a post request to a JSON returning source and casts the object

throws

RequestCancelledException when the request is cancelled

throws

ServiceException if the response is cancelled or if there was a status code in the error range

Type parameters
- TData
- TResponseData
Parameters
- uri: StringOrUrl
  
  as string or Uri
- data: TData
Returns Promise<TResponseData>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns XhrHttpClient

Parameters

filters: IHttpFilter[]

Returns XhrHttpClient

Parameters

filters: IHttpFilter[]

headers: IHttpRequestHeaderCollection

Returns XhrHttpClient

Parameters

filters: IHttpFilter[]

headers: IHttpRequestHeaderCollection

ignoreCache: boolean

Returns XhrHttpClient

Parameters

filters: IHttpFilter[]

headers: IHttpRequestHeaderCollection

ignoreCache: boolean

timeout: number

Returns XhrHttpClient

Parameters

Optional filters: IHttpFilter[]

Optional headers: IHttpRequestHeaderCollection

Optional ignoreCache: undefined | false | true

Optional timeout: undefined | number

Returns XhrHttpClient

Properties

Private _headers

Private _ignoreCache

Private _timeout

filters

Static DefaultHeaders

Static DefaultIgnoreCache

Static DefaultTimeout

Methods

createRequest

Parameters

method: HttpMethod

uri: string

Returns IHttpRequest

Parameters

method: HttpMethod

uri: Url

Returns IHttpRequest

Parameters

method: HttpMethod

uri: StringOrUrl

Returns IHttpRequest

getObjectAsync

Type parameters

T

Parameters

uri: string

Returns Promise<T>

Type parameters

T

Parameters

uri: Url

Returns Promise<T>

Type parameters

T

Parameters

uri: StringOrUrl

Returns Promise<T>

postObjectAsync

Type parameters

TData

TResponseData

Parameters

uri: string

data: TData

Returns Promise<TResponseData>

Type parameters