Type Alias RouterConfig

RouterConfig: TransactionConfig & {
    containerSetupHook?: (
        server: HTTPServer,
        app: express.Express,
    ) => Promise<void>;
    cors?: {
        allowCredentials?: boolean;
        headers?: string[];
        origin?: string | string[];
    };
    healthCheckRoute?: string;
    port?: number;
    routes: AnyRoute[];
    timeout?: number;
}

Represents the configuration options for a router.

Type declaration

OptionalcontainerSetupHook?: (server: HTTPServer, app: express.Express) => Promise<void>
Optionalcors?: { allowCredentials?: boolean; headers?: string[]; origin?: string | string[] }
Configuration options for Cross-Origin Resource Sharing (CORS).
OptionalhealthCheckRoute?: string
The route for the health check endpoint.
Optionalport?: number
The port number for the server to listen on.
routes: AnyRoute[]
An array of route objects representing the available routes in the application.
Optionaltimeout?: number
Optional timeout value in milliseconds.

Type Alias RouterConfig

Type declaration

`Optional`containerSetupHook?: (server: HTTPServer, app: express.Express) => Promise<void>

`Optional`cors?: { allowCredentials?: boolean; headers?: string[]; origin?: string | string[] }

`Optional`healthCheckRoute?: string

`Optional`port?: number

routes: AnyRoute[]

`Optional`timeout?: number

Settings

Type Alias RouterConfig

Type declaration

OptionalcontainerSetupHook?: (server: HTTPServer, app: express.Express) => Promise<void>

Optionalcors?: { allowCredentials?: boolean; headers?: string[]; origin?: string | string[] }

OptionalhealthCheckRoute?: string

Optionalport?: number

routes: AnyRoute[]

Optionaltimeout?: number

Settings

`Optional`containerSetupHook?: (server: HTTPServer, app: express.Express) => Promise<void>

`Optional`cors?: { allowCredentials?: boolean; headers?: string[]; origin?: string | string[] }

`Optional`healthCheckRoute?: string

`Optional`port?: number

`Optional`timeout?: number