@darthcav/ts-http-server
    Preparing search index...

    Type Alias DefaultPluginsOptions

    Options accepted by the defaultPlugins function.

    type DefaultPluginsOptions = {
        baseDir?: string | null;
        cors?: FastifyCorsOptions;
        docs?: boolean;
        keycloakAuth?: KeycloakAuthConfig;
        locals: LauncherLocals;
    }
    Index

    Properties

    baseDir? cors? docs? keycloakAuth? locals

    Properties

    baseDir?: string | null

    Optional base directory for resolving the src/ folder; defaults to the parent of import.meta.dirname.

    cors?: FastifyCorsOptions

    Options forwarded to @fastify/cors. Merged over a secure default of { origin: false }, which disables cross-origin requests (same-origin only). To allow specific origins, set cors: { origin: [...] } with an explicit allowlist; avoid origin: true (reflects every origin) in production.

    docs?: boolean

    Whether to register Swagger UI (/docs) and the OpenAPI spec endpoints. These publish the full endpoint map and are reachable unauthenticated, so they are disabled in production by default. When omitted, defaults to true unless NODE_ENV === "production", in which case it defaults to false. Set explicitly to override.

    keycloakAuth?: KeycloakAuthConfig

    Optional Keycloak configuration used to mark the generated /api/ OpenAPI operations as OpenID Connect–protected.

    locals: LauncherLocals

    Application locals; locals.pkg is exposed as the default EJS context.

    Settings

    Member Visibility

    On This Page

    Properties