Setu-TS
    Preparing search index...

    Interface RestStarterOptions

    Options for createRestApp. Per-plugin optional arms are threaded straight through to each plugin factory. Omitted plugins use their default configuration (no arguments required).

    RestStarterOptions

    interface RestStarterOptions {
        auth?: AuthPluginOptions;
        config?: ConfigPluginOptions;
        database?: DatabasePluginOptions;
        decorators?: DecoratorPluginOptions;
        di?: DiPluginOptions;
        graphql?: GraphqlPluginOptions;
        health?: HealthPluginOptions;
        httpSecurity?: HttpSecurityPluginOptions;
        logger?: LoggerPluginOptions;
        metrics?: MetricsPluginOptions;
        openapi?: OpenApiPluginOptions;
        realtime?: RealtimeArm;
        serviceDiscovery?: ServiceDiscoveryPluginOptions;
        session?: SessionPluginOptions;
        validation?: ValidationPluginOptions;
    }

    Hierarchy (View Summary)

    Index
    auth? config? database? decorators? di? graphql? health? httpSecurity? logger? metrics? openapi? realtime? serviceDiscovery? session? validation?
    auth?: AuthPluginOptions

    Optional arm: AuthPlugin. Provided only when the caller supplies auth configuration; omitted → auth not registered. Configure at least one passive strategy (jwt, apiKey, session, or strategies). The plugin registers its authentication middleware globally unless disabled.

    config?: ConfigPluginOptions

    Options for ConfigPlugin. Omitted → defaults.

    database?: DatabasePluginOptions

    Optional arm: DatabasePlugin. Provided only when the caller supplies database credentials; omitted → database not registered.

    decorators?: DecoratorPluginOptions

    Options for DecoratorPlugin. Omitted → defaults.

    di?: DiPluginOptions

    Optional arm: DiPlugin. Omitted → decorated services are constructed directly and registered in the kernel's ServiceRegistry, which is the default and needs no container.

    Supplying this arm changes how every decorated service in the application is constructed: DecoratorPlugin branches on the presence of a container, so with this arm each @Injectable class becomes a container provider that honors its scope. That is why it is gated rather than always-on — the default composition stays identical to a starter app without it.

    graphql?: GraphqlPluginOptions

    Optional arm: GraphqlPlugin. Gated because the plugin cannot boot without an application-supplied schema — the rule that made session gated.

    0.3.0

    health?: HealthPluginOptions

    Options for HealthPlugin. Omitted → defaults.

    httpSecurity?: HttpSecurityPluginOptions

    Options for HttpSecurityPlugin. Omitted → defaults.

    logger?: LoggerPluginOptions

    Options for LoggerPlugin. Omitted → defaults.

    metrics?: MetricsPluginOptions

    Options for MetricsPlugin. Omitted → defaults.

    openapi?: OpenApiPluginOptions

    Options for OpenApiPlugin. Omitted → defaults.

    realtime?: RealtimeArm

    Optional arm: the real-time plugins, one per sub-arm. Omitted → none of the three is registered.

    RealtimeArm

    serviceDiscovery?: ServiceDiscoveryPluginOptions

    Optional arm: ServiceDiscoveryPlugin. Provided → service discovery is registered; omitted → no discovery capability is added.

    session?: SessionPluginOptions

    Optional arm: SessionPlugin. Omitted → the application has no cookie session and no session-backed form CSRF.

    Gated because a session needs a secret nobody can default: the plugin throws during register() without one, so an always-on arm would make every starter application fail to boot until it supplied one. It is also genuinely optional — a token-authenticated API has no use for cookies, which is what auth covers.

    Setting csrf additionally registers the synchronizer-token middleware at priority 325, which is the check a progressive-enhancement <Form> post can satisfy — unlike the stateless Origin/Referer check that httpSecurity performs, which a form structurally cannot. Running both is intended.

    const app = createRestApp({
      session: { secret: mySecret, csrf: {} },
    });
    validation?: ValidationPluginOptions

    Options for ValidationPlugin. Omitted → defaults.

    Settings
    Member Visibility

    On This Page
    Properties