@bearnjs/rest
    Preparing search index...

    Interface AppOptions

    Options for configuring server behavior and logging during startup. AppOptions

    interface AppOptions {
        appDescription?: string;
        appName?: string;
        appVersion?: string;
        backlog?: number;
        cors?: false | CorsOptions;
        disableLogging?: boolean;
        host?: string;
        includeInternal?: boolean;
        port?: number;
        printRoutes?: boolean;
        rootPrefix?: string;
    }
    Index

    Properties

    appDescription? appName? appVersion? backlog? cors? disableLogging? host? includeInternal? port? printRoutes? rootPrefix?

    Properties

    appDescription?: string

    A brief description of the application.

    appName?: string

    The name of the application.

    appVersion?: string

    The version of the application.

    backlog?: number

    The size of the listen backlog.

    cors?: false | CorsOptions

    The CORS configuration for the server.

    disableLogging?: boolean

    Whether to disable logging during startup.

    host?: string

    The host address the server should listen on.

    includeInternal?: boolean

    Whether to include internal routes in the printed table.

    port?: number

    The port number the server should listen on.

    printRoutes?: boolean

    Whether to print the route table on startup.

    rootPrefix?: string

    A global prefix to apply to all application routes.

    // Example usage:
    const options: AppOptions = { rootPrefix: '/api' };

    Settings

    Member Visibility

    On This Page

    Properties