ServiceBuilder

Home > @backstage/backend-common > ServiceBuilder

A helper for building backend service instances.

Signature:

export type ServiceBuilder = {
    loadConfig(config: Config): ServiceBuilder;
    setPort(port: number): ServiceBuilder;
    setHost(host: string): ServiceBuilder;
    setLogger(logger: LoggerService): ServiceBuilder;
    enableCors(options: cors.CorsOptions): ServiceBuilder;
    setHttpsSettings(settings: {
        certificate: {
            key: string;
            cert: string;
        } | {
            hostname: string;
        };
    }): ServiceBuilder;
    addRouter(root: string, router: Router | RequestHandler): ServiceBuilder;
    setRequestLoggingHandler(requestLoggingHandler: RequestLoggingHandlerFactory): ServiceBuilder;
    setErrorHandler(errorHandler: ErrorRequestHandler): ServiceBuilder;
    disableDefaultErrorHandler(): ServiceBuilder;
    start(): Promise<Server>;
};

References: Config, ServiceBuilder, LoggerService, RequestLoggingHandlerFactory