Class CompanionConnector

Companion Connector. This class is the main class of the library. It contains the rest and socket client. You can also use the RestClient and SocketClient directly if you want to. But you have to manage the settings update for both clients yourself.

Index

Constructors

Accessors

restClient settings socketClient

Methods

Constructors

constructor

new CompanionConnector(settings): CompanionConnector
Parameters
- settings: Settings
Returns CompanionConnector
- Defined in companion-connector.ts:12

Accessors

restClient

get restClient(): RestClient
Get the rest client

Returns RestClient
- Defined in companion-connector.ts:29

settings

get settings(): Settings
Get the settings

Returns Settings
- Defined in companion-connector.ts:45
set settings(value): void
Set the settings
Parameters
- value: Settings
Returns void
- Defined in companion-connector.ts:53

socketClient

get socketClient(): SocketClient
Get the socket client

Returns SocketClient
- Defined in companion-connector.ts:37

Methods

setAuthToken

setAuthToken(token): void
Set the authentication token, so it can be used for further requests. This automatically sets the token for both clients and reconnects the socket client if the token changed.
Parameters
- token: string
  The token to set
Returns void
- Defined in companion-connector.ts:63