Interface IEndpointCallerOptions

Possible options when creating a EndpointCaller

Index

accessToken: string

The access token to use for this endpoint.

password: string

The password to use to log into this endpoint. Used for basic auth.
Not used if accessToken is provided.

requestModifier: function

A function which will allow external code to modify all endpoint call parameters before they are sent by the browser.

Used in very specific scenario where the network infrastructure require special request headers to be added or removed, for example.

- (params: IRequestInfo<any>): IRequestInfo<any>
- Parameters
  - params: IRequestInfo<any>
  Returns IRequestInfo<any>

username: string

The username to use to log into this endpoint. Used for basic auth.
Not used if accessToken is provided.

xmlHttpRequest: object

The XmlHttpRequest implementation to use instead of the native one. If not specified, the native one is used.