Class Ratchet

Hierarchy

default
- Ratchet

Index

Constructors

Properties

client env host token

Methods

query setClient

Constructors

constructor

new Ratchet(options?: { env?: string; host?: string; token?: string }): Ratchet
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns Ratchet
Inherited from PlatformBaseClient.constructor
- Defined in api/platformBaseClient.ts:25

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

query

query(name: string, params: any): Promise<AxiosResponse<any, any>>
Parameters
- name: string
- params: any
Returns Promise<AxiosResponse<any, any>>
- Defined in api/ratchet.ts:4

setClient

setClient(client: AxiosInstance): Ratchet
Parameters
- client: AxiosInstance
Returns Ratchet
Inherited from PlatformBaseClient.setClient
- Defined in api/baseClient.ts:10