Type Alias RunOptions

Type declaration

• Optionaldebug?: DebugFriendlyConfig

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

• OptionaldryRun?: 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.

• OptionalerrorBoundary?: boolean

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

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

  Configure logging settings.

  • 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.

• Optionalmode?: 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.

• OptionalonUnhandledError?: OnUnhandledError

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

• OptionalruntimeCycleDetection?: boolean

  Defaults to true. When set, forces runtime cycle detection for event emissions. Disable if you're sure you don't have event deadlocks to improve event emission performance.

• OptionalshutdownHooks?: boolean

  When true (default), installs SIGINT/SIGTERM handlers that call dispose() on the root allowing for graceful shutdown.