Iskra API Reference
    Preparing search index...

    Interface AppConfig

    interface AppConfig {
        db?: {
            authToken?: string;
            driver: "postgres" | "mysql" | "sqlite" | "libsql";
            url: string;
        };
        debug?: boolean;
        kv?: {
            connection?: string
            | Record<string, unknown>;
            driver: "memory" | "redis";
        };
        logger?: { level?: string };
        name: string;
        otel?: OtelConfig;
        processes?: Record<string, ProcessConfig>;
        shutdownSignals?: false | string[];
        shutdownTimeoutMs?: number;
        socket?: { adapter?: "bun" | "socket.io"; enabled: boolean; port?: number };
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Sections of other kits or of the app; read them with their own type.

    Index
    db? debug? kv? logger? name otel? processes? shutdownSignals? shutdownTimeoutMs? socket?
    db?: {
        authToken?: string;
        driver: "postgres" | "mysql" | "sqlite" | "libsql";
        url: string;
    }
    debug?: boolean
    kv?: {
        connection?: string | Record<string, unknown>;
        driver: "memory" | "redis";
    }

    Type Declaration

    • Optionalconnection?: string | Record<string, unknown>

      Redis: a URL string, ioredis options, or ioredis options with url.

    • driver: "memory" | "redis"
    logger?: { level?: string }
    name: string
    otel?: OtelConfig
    processes?: Record<string, ProcessConfig>
    shutdownSignals?: false | string[]

    Signals that trigger a graceful stop() and exit. Default ['SIGTERM', 'SIGINT'] (none under NODE_ENV=test); false disables.

    shutdownTimeoutMs?: number

    Max time for a signal-triggered stop before forcing exit(1). Default 10000.

    socket?: { adapter?: "bun" | "socket.io"; enabled: boolean; port?: number }

    Settings
    Member Visibility

    On This Page
    Properties