@bluelibs/runner - v6.3.1
    Preparing search index...

    Type Alias RunOptions

    Public runtime options accepted by run(app, options).

    type RunOptions = {
        debug?: DebugFriendlyConfig;
        dispose?: DisposeOptions;
        dryRun?: boolean;
        errorBoundary?: boolean;
        executionContext?: boolean | ExecutionContextOptions;
        identity?: IdentityAsyncContext;
        lazy?: boolean;
        lifecycleMode?: ResourceLifecycleMode | "sequential" | "parallel";
        logs?: {
            bufferLogs?: boolean;
            printStrategy?: PrintStrategy;
            printThreshold?: null | LogLevels;
        };
        mode?: RunnerMode;
        onUnhandledError?: OnUnhandledError;
        shutdownHooks?: boolean;
        signal?: AbortSignal;
    }
    Index

    Properties

    Defaults to undefined. If true, we introduce logging to the console.

    dispose?: DisposeOptions

    Shutdown disposal configuration.

    dryRun?: boolean

    Defaults to false.

    Dry run mode. When true, the runner will setup the system, ensure there are no errors, but will not start the system. Your resources will not be initialized, and no events will be emitted. This is useful for testing and debugging.

    Note: this cannot catch init() errors that happen within resources.

    errorBoundary?: boolean

    When true (default), installs a central error boundary that catches uncaught errors from process-level events and routes them to onUnhandledError.

    executionContext?: boolean | ExecutionContextOptions

    Enables built-in execution tracing and cycle detection for this runtime.

    Overrides which async context Runner reads for identity-aware framework features such as identity-scoped cache, rate limits, and temporal policies.

    App code should continue using this context directly for provide(), use(), and require(). Runner also auto-registers the configured context inside the runtime so it can be used as a dependency.

    lazy?: boolean

    Defaults to false. When true, startup skips initializing resources that are not used during bootstrap. Such resources can be initialized on-demand via runResult.getLazyResourceValue(...).

    lifecycleMode?: ResourceLifecycleMode | "sequential" | "parallel"

    Defaults to sequential. Controls startup and disposal scheduling behavior.

    logs?: {
        bufferLogs?: boolean;
        printStrategy?: PrintStrategy;
        printThreshold?: null | LogLevels;
    }

    Configure logging settings.

    Type Declaration

    • OptionalbufferLogs?: boolean

      Defaults to false. If true, we buffer logs until the root resource is ready. This provides you with the chance to see the logs before the root resource is ready.

    • OptionalprintStrategy?: PrintStrategy

      Defaults to PRETTY. How to print the logs.

    • OptionalprintThreshold?: null | LogLevels

      Defaults to info. Use null to disable logging.

    mode?: RunnerMode

    Specify in which mode to run "dev", "prod" or "test". If inside Node this is automatically detected from the NODE_ENV environment variable if not provided.

    onUnhandledError?: OnUnhandledError

    Custom handler for any unhandled error caught by Runner. Defaults to logging via the created logger.

    shutdownHooks?: boolean

    When true (default), installs SIGINT/SIGTERM handlers that trigger graceful shutdown. Signals received during bootstrap will cancel startup, rollback initialized resources, and exit cleanly once teardown completes.

    signal?: AbortSignal

    External shutdown trigger for the runtime lifecycle. Aborting this signal cancels bootstrap before readiness (rolling back any initialized resources) or starts graceful disposal after the runtime is ready, without affecting ambient execution signals.