Client | @tillhub/javascript-sdk

The Tillhub HTTP client is an axios instance that carries the state of of Authentication in - if default headers have been set - has Authorization header.

Since this class is a singleton we are destroying state internally through .clearInstance().

Hierarchy

Client

Index

Constructors

constructor

Properties

Methods

Constructors

Private constructor

new Client(options: ClientOptions): Client

- Defined in src/client.ts:35
Parameters
- options: ClientOptions
Returns Client

Properties

Private Readonly axiosInstance

axiosInstance: AxiosInstance

Private requestInterceptorIds

requestInterceptorIds: number[] = []

Private responseInterceptorIds

responseInterceptorIds: number[] = []

Static Private instance

instance: Client

Methods

clearDefaults

clearDefaults(): void

- Defined in src/client.ts:115
Returns void

getClient

getClient(): AxiosInstance

- Defined in src/client.ts:66
Returns AxiosInstance

setDefaults

setDefaults(options: ClientOptions): Client

- Defined in src/client.ts:70
Parameters
- options: ClientOptions
Returns Client

Static clearInstance

clearInstance(): void

- Defined in src/client.ts:62
Returns void

Static getInstance

getInstance(options: ClientOptions): Client

- Defined in src/client.ts:48
Parameters
- options: ClientOptions
Returns Client

Generated using TypeDoc