Class DominoServer

Contains available APIs of Domino REST API server and maps each of it to its own DominoConnector.

Author

stephan.wissel@hcl.software

Author

emmanuelryan.gamla@hcl.software

Author

alecvincent.bardiano@hcl.software

Implements

DominoRestServer

Index

Properties

apiMap baseUrl connectorMap

Methods

availableApis availableOperations getDominoConnector getServer

Properties

apiMap

apiMap: Map<string, DominoApiMeta> = ...

Maps APIs loaded from Domino REST API server's /api endpoint.

baseUrl

baseUrl: string

Base URL of Domino REST API server.

connectorMap

connectorMap: Map<string, DominoConnector> = ...

Maps APIs to its own DominoConnector.

Methods

availableApis

availableApis(): string[]
Returns string[]
an array of available APIs.
Implementation of DominoRestServer.availableApis
- Defined in src/DominoServer.ts:78

availableOperations

availableOperations(apiName: string): Promise<Map<string, any>>
Parameters
- apiName: string
  the API that contains all the operations.
Returns Promise<Map<string, any>>
a promise that resolves a map with operation ID as keys and the operation's specifications as the value.
Implementation of DominoRestServer.availableOperations
- Defined in src/DominoServer.ts:99

getDominoConnector

getDominoConnector(apiName: string): Promise<DominoConnector>
Parameters
- apiName: string
  the API that will be used for the DominoConnector
Returns Promise<DominoConnector>
a promise that resolves to DominoConnector of the given API.
Implementation of DominoRestServer.getDominoConnector
- Defined in src/DominoServer.ts:80

`Static`getServer

getServer(baseUrl: string): Promise<DominoServer>
Factory for getting DominoServer class.
Parameters
- baseUrl: string
  base URL of Domino REST API server
Returns Promise<DominoServer>
a DominoServer class

Throws
an error if something went wrong on loading APIs
- Defined in src/DominoServer.ts:60