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

    Interface DominoRestConnector

    OpenAPI aware connection to the Domino REST API backend. All interactions flow through it.

    interface DominoRestConnector {
        baseUrl: string;
        getFetchOptions: (
            dominoAccess: DominoRestAccess,
            operation: DominoRestOperation,
            request: DominoRequestOptions,
        ) => Promise<any>;
        getOperation: (operationId: string) => DominoRestOperation;
        getOperations: () => Map<string, any>;
        getUrl: (
            operation: DominoRestOperation,
            scope: string,
            params: Map<string, string>,
        ) => string;
        meta: DominoApiMeta;
        request: (
            dominoAccess: DominoRestAccess,
            operationId: string,
            options: DominoRequestOptions,
        ) => Promise<DominoRequestResponse>;
    }

    Implemented by

    Index

    Properties

    baseUrl getFetchOptions getOperation getOperations getUrl meta request

    Properties

    baseUrl: string

    URL of Domino REST API server to interact with.

    getFetchOptions: (
        dominoAccess: DominoRestAccess,
        operation: DominoRestOperation,
        request: DominoRequestOptions,
    ) => Promise<any>

    Builds request options around the given operation information (this includes the headers and the request body).

    Type declaration

    an error if a mandatory header parameter is not given.

    an error if something went wrong on building request options.

    getOperation: (operationId: string) => DominoRestOperation

    Return information about the given operation ID.

    Type declaration

    an error if given operation ID cannot be found.

    getOperations: () => Map<string, any>

    Get all operations available on the connector.

    Type declaration

      • (): Map<string, any>

      • Returns Map<string, any>

        all operations for the connector.

    getUrl: (
        operation: DominoRestOperation,
        scope: string,
        params: Map<string, string>,
    ) => string

    Builds a fully qualified URL around the given operation information based on supplied parameters.

    Type declaration

      • (
            operation: DominoRestOperation,
            scope: string,
            params: Map<string, string>,
        ): string

      • Parameters

        • operation: DominoRestOperation

          JSON information about the operation

        • scope: string

          target scope name

        • params: Map<string, string>

          parameters to supply to the URL

        Returns string

        the URL built.

    meta: DominoApiMeta

    Metadata by each APIs returned from /api endpoint.

    request: (
        dominoAccess: DominoRestAccess,
        operationId: string,
        options: DominoRequestOptions,
    ) => Promise<DominoRequestResponse>

    Sends the specified operation as request to the server.

    Type declaration

    an error if response is not okay.

    Settings

    Member Visibility

    On This Page

    Properties