bunqueue v2.8 API referenceall versions · guide
bunqueue
    Preparing search index...

    Interface BunqueueConfig

    Global bunqueue configuration (all sections optional)

    interface BunqueueConfig {
        auth?: { requireAuthForMetrics?: boolean; tokens?: string[] };
        backup?: {
            accessKeyId?: string;
            bucket?: string;
            enabled?: boolean;
            endpoint?: string;
            interval?: number;
            prefix?: string;
            region?: string;
            retention?: number;
            secretAccessKey?: string;
            sessionToken?: string;
            virtualHostedStyle?: boolean;
        };
        cloud?: { apiKey?: string; instanceId?: string; url?: string };
        cors?: { origins?: string[] };
        logging?: {
            format?: "text" | "json";
            level?: "info" | "warn" | "error" | "debug";
        };
        server?: {
            host?: string;
            httpPort?: number;
            httpSocketPath?: string;
            tcpPort?: number;
            tcpSocketPath?: string;
            tlsCertFile?: string;
            tlsKeyFile?: string;
        };
        storage?: { dataPath?: string };
        telemetry?: { maxPrometheusQueues?: number };
        timeouts?: {
            lock?: number;
            shutdown?: number;
            stats?: number;
            worker?: number;
        };
        webhooks?: { maxRetries?: number; retryDelay?: number };
    }
    Index
    auth?: { requireAuthForMetrics?: boolean; tokens?: string[] }
    backup?: {
        accessKeyId?: string;
        bucket?: string;
        enabled?: boolean;
        endpoint?: string;
        interval?: number;
        prefix?: string;
        region?: string;
        retention?: number;
        secretAccessKey?: string;
        sessionToken?: string;
        virtualHostedStyle?: boolean;
    }
    cloud?: { apiKey?: string; instanceId?: string; url?: string }
    cors?: { origins?: string[] }
    logging?: {
        format?: "text" | "json";
        level?: "info" | "warn" | "error" | "debug";
    }
    server?: {
        host?: string;
        httpPort?: number;
        httpSocketPath?: string;
        tcpPort?: number;
        tcpSocketPath?: string;
        tlsCertFile?: string;
        tlsKeyFile?: string;
    }

    Type Declaration

    • Optionalhost?: string
    • OptionalhttpPort?: number
    • OptionalhttpSocketPath?: string
    • OptionaltcpPort?: number
    • OptionaltcpSocketPath?: string
    • OptionaltlsCertFile?: string

      Path to PEM certificate file — enables native TLS on TCP + HTTP (with tlsKeyFile)

    • OptionaltlsKeyFile?: string

      Path to PEM private key file — enables native TLS on TCP + HTTP (with tlsCertFile)

    storage?: { dataPath?: string }
    telemetry?: { maxPrometheusQueues?: number }

    Type Declaration

    • OptionalmaxPrometheusQueues?: number

      Maximum queue label values exposed to Prometheus; zero disables per-queue series.

    timeouts?: { lock?: number; shutdown?: number; stats?: number; worker?: number }
    webhooks?: { maxRetries?: number; retryDelay?: number }