@hcl-software/domino-rest-sdk-node
    Preparing search index...

    Interface DominoRestServer

    User and session independent information on Domino REST API server.

    interface DominoRestServer {
        apiMap: Map<string, DominoApiMeta>;
        availableApis: () => string[];
        availableOperations: (apiName: string) => Promise<Map<string, any>>;
        baseUrl: string;
        getDominoConnector: (apiName: string) => Promise<DominoConnector>;
    }

    Implemented by

    Index

    Properties

    apiMap availableApis availableOperations baseUrl getDominoConnector

    Properties

    apiMap: Map<string, DominoApiMeta>

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

    availableApis: () => string[]

    Gets all available APIs on Domino REST API server. Will fetch from /api endpoint if API map is yet to be loaded.

    Type declaration

      • (): string[]

      • Returns string[]

        an array of available APIs.

    availableOperations: (apiName: string) => Promise<Map<string, any>>

    Gets all available operations with its specifications under the given API.

    Type declaration

      • (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.

    an error when it failed to load available APIs from Domino REST API server.

    baseUrl: string

    Base URL of Domino REST API server.

    getDominoConnector: (apiName: string) => Promise<DominoConnector>

    Get a DominoConnector instance of the given API name.

    Type declaration

      • (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.

    an error if given API name is not available on the server.

    Settings

    Member Visibility

    On This Page

    Properties