Module clients

Index

Classes

AuthStore

Service Interfaces

Other Interfaces

Functions

Const AdminService

AdminService(authData?: AuthData): Promise<AdminService>

- Defined in src/clients/admin/AdminService.ts:96
Instantiate Admin service.

Parameters
- Optional authData: AuthData
  
  A record which contains tokenFactory and username
Returns Promise<AdminService>

AdminService as Promise

Const AgentService

AgentService(authData?: AuthData): Promise<AgentService>

- Defined in src/clients/agent-service/AgentService.ts:61
Parameters
- Optional authData: AuthData
Returns Promise<AgentService>

Const AlarmService

AlarmService(): Promise<AlarmService>

- Defined in src/clients/alarm/AlarmService.ts:30
Instantiate Alarm service.

Returns Promise<AlarmService>

AlarmService as Promise

Const CommandService

CommandService(componentId: ComponentId, authData?: AuthData): Promise<CommandService>

- Defined in src/clients/command/CommandService.ts:114
Instantiate command service to enable interaction with the component.

Parameters
- componentId: ComponentId
  
  Component id for which command service is to be instantiated.
- Optional authData: AuthData
  
  a record which contains tokenFoctory and username
Returns Promise<CommandService>

CommandService as Promise

Const ConfigService

ConfigService(tokenFactory: TokenFactory): Promise<ConfigService>

- Defined in src/clients/config-service/ConfigService.ts:173
Instantiate Config service to enable interaction with the config server.

Parameters
- tokenFactory: TokenFactory
  
  a function that returns a valid token which has correct access roles and permissions for the config server.
Returns Promise<ConfigService>

ConfigService as Promise

Const EventService

EventService(authData?: AuthData): Promise<EventService>

- Defined in src/clients/event/EventService.ts:87
Instantiate Event service to enable interaction with the event server.

Parameters
- Optional authData: AuthData
Returns Promise<EventService>

Const LocationService

LocationService(authData?: AuthData): LocationService

- Defined in src/clients/location/LocationService.ts:121
Instantiates the location service.

Parameters
- Optional authData: AuthData
Returns LocationService

Const LocationServiceInternal

LocationServiceInternal(authData?: AuthData, locationConfig?: LocationInfo): LocationService

- Defined in src/clients/location/LocationService.ts:109
(DO NOT USE IN PRODUCTION) this constructor is used in testing & will get deleted eventually.

Parameters
- Optional authData: AuthData
- Optional locationConfig: LocationInfo
Returns LocationService

Const LoggingService

LoggingService(authData?: AuthData): Promise<LoggingService>

- Defined in src/clients/logger/LoggingService.ts:33
Instantiate logging service.

Parameters
- Optional authData: AuthData
Returns Promise<LoggingService>

LoggingService as Promise

Const SequenceManagerService

SequenceManagerService(authData?: AuthData): Promise<SequenceManagerService>

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:132
Instantiate SequenceManagerService to enable interaction with the sequencer

Parameters
- Optional authData: AuthData
Returns Promise<SequenceManagerService>

SequencerService as Promise

Const SequencerService

SequencerService(componentId: ComponentId, authData?: AuthData): Promise<SequencerService>

- Defined in src/clients/sequencer/SequencerService.ts:260
Instantiate SequencerService to enable interaction with the sequencer

Parameters
- componentId: ComponentId
  
  component id for which sequencer service is to be instantiated.
- Optional authData: AuthData
Returns Promise<SequencerService>

SequenceManagerService as Promise

Const createAdminService

createAdminService(location: Location, authData?: AuthData): AdminService

- Defined in src/clients/admin/AdminService.ts:101
Parameters
- location: Location
- Optional authData: AuthData
Returns AdminService

Const createAgentService

createAgentService(location: Location, authData?: AuthData): AgentService

- Defined in src/clients/agent-service/AgentService.ts:66
Parameters
- location: Location
- Optional authData: AuthData
Returns AgentService

Const createAlarmService

createAlarmService(location: Location): AlarmService

- Defined in src/clients/alarm/AlarmService.ts:35
Parameters
- location: Location
Returns AlarmService

Const createCommandService

createCommandService(componentId: ComponentId, location: Location, authData?: AuthData): CommandService

- Defined in src/clients/command/CommandService.ts:119
Parameters
- componentId: ComponentId
- location: Location
- Optional authData: AuthData
Returns CommandService

Const createConfigService

createConfigService(location: Location, tokenFactory: TokenFactory): ConfigService

- Defined in src/clients/config-service/ConfigService.ts:178
Parameters
- location: Location
- tokenFactory: TokenFactory
Returns ConfigService

Const createEventService

createEventService(location: Location, authData?: AuthData): EventService

- Defined in src/clients/event/EventService.ts:92
Parameters
- location: Location
- Optional authData: AuthData
Returns EventService

Const createLoggingService

createLoggingService(location: Location, authData?: AuthData): LoggingService

- Defined in src/clients/logger/LoggingService.ts:38
Parameters
- location: Location
- Optional authData: AuthData
Returns LoggingService

Const createSequenceManagerService

createSequenceManagerService(location: Location, authData?: AuthData): SequenceManagerService

- Defined in src/clients/sequence-manager/SequenceManagerService.ts:137
Parameters
- location: Location
- Optional authData: AuthData
Returns SequenceManagerService

Const createSequencerService

createSequencerService(componentId: ComponentId, location: Location, authData?: AuthData): SequencerService

- Defined in src/clients/sequencer/SequencerService.ts:265
Parameters
- componentId: ComponentId
- location: Location
- Optional authData: AuthData
Returns SequencerService

Generated using TypeDoc