Theia API Documentation v1.76.0
    Preparing search index...

    Interface ExternalApiRouterOptions

    Instantiation options of an ExternalApiRouter, provided by the external API server.

    interface ExternalApiRouterOptions {
        contributionPath: string;
        isAuthorized?: (request: Request) => boolean;
        router: Router;
    }
    Index

    Properties

    contributionPath isAuthorized? router

    Properties

    contributionPath: string

    Path under which the contribution's routes are mounted, used to give log messages context.

    isAuthorized?: (request: Request) => boolean

    Checks whether a request carries the configured external API token, see RestRequest.authorized. undefined when no token is configured; every request counts as authorized then.

    router: Router

    The underlying express router.

    Settings

    Member Visibility

    On This Page

    Properties