BSB Node.js Type Definitions
    Preparing search index...

    Interface BSBOptions

    Configuration options for ServiceBase constructor

    API: BSBOptions

    interface BSBOptions {
        debug?: boolean;
        live?: boolean;
        cwd?: string;
        appId?: string;
        region?: string;
        runtimeMode?: BSBRuntimeMode;
        config?: typeof SBConfig;
        plugins?: typeof SBPlugins;
        observable?: typeof SBObservable;
        events?: typeof SBEvents;
        services?: typeof SBServices;
    }
    Index

    Properties

    debug? live? cwd? appId? region? runtimeMode? config? plugins? observable? events? services?

    Properties

    debug?: boolean

    Enable debug logging

    true
    live?: boolean

    Disable development mode (affects plugin loading)

    false
    cwd?: string

    Current working directory

    process.cwd()
    appId?: string

    Custom application ID (overrides auto-generated ID)

    undefined (auto-generated from hostname + UUID)
    region?: string

    Deployment region for resource context

    undefined (resolved from BSB_REGION env var)
    runtimeMode?: BSBRuntimeMode

    Runtime mode controls how plugins are resolved.

    • prod: compiled JavaScript only
    • dev: prefer TypeScript, then fall back to JavaScript

    derived from live

    config?: typeof SBConfig

    Override default configuration handler

    SBConfig
    plugins?: typeof SBPlugins

    Override default plugins handler

    SBPlugins
    observable?: typeof SBObservable

    Override default observable handler (unified logging, metrics, tracing)

    SBObservable
    events?: typeof SBEvents

    Override default events handler

    SBEvents
    services?: typeof SBServices

    Override default services handler

    SBServices

    Settings

    Member Visibility

    On This Page

    Properties