API Reference · BitDiver

The full TypeDoc API reference will be generated from the source code in a future update.

Package Exports

All public APIs are exported from the main package entry point:

import {
  // Config
  loadConfig,

  // Suite Builder
  createSuiteFromConfig,
  buildTimedSteps,
  scanTimedFiles,
  suiteConfigSchema,

  // Model — Steps
  StepBase,
  StepNormal,
  StepSingle,
  StepTimed,            // deprecated
  StepSetupConfig,
  StepRegistry,

  // Model — Built-in Timing Steps
  StepWait,
  StepDetermineStartTime,
  StepCheckStartTime,
  REFERENCE_TIME_KEY,

  // Model — Environments
  EnvironmentRun,
  EnvironmentTestcase,

  // Runner
  Runner,

  // Check
  StepCheck,

  // Log Adapters
  LogAdapterConsole,
  LogAdapterConsoleJson,
  LogAdapterFile,
  LogAdapterMemory,

  // Constants
  STATUS_OK,
  STATUS_WARNING,
  STATUS_ERROR,
  STATUS_FATAL
} from '@xhubio/bitdiver-runner'

Quick Reference

Export	Module	Description
`loadConfig()`	Config	Load and validate configuration from file + env vars + inline values
`createSuiteFromConfig()`	Suite Builder	Create suite definition from config (three phases: setup → timed → teardown)
`buildTimedSteps()`	Suite Builder	Generate timed step definitions from parsed file names
`scanTimedFiles()`	Suite Builder	Scan directories for timed test data files
`suiteConfigSchema`	Suite Builder	Zod schema for suite builder configuration
`StepNormal`	Model	Base class for per-testcase steps
`StepSingle`	Model	Base class for once-per-suite steps
`StepTimed`	Model	Base class for time-delayed steps (deprecated — use Runner-managed timing)
`StepSetupConfig`	Model	Generic config-loading step
`StepWait`	Model	Built-in wait step (skipped in testMode). Pre-registered as `Wait`
`StepDetermineStartTime`	Model	Calculates reference time for timed steps. Pre-registered as `DetermineStartTime`
`StepCheckStartTime`	Model	Verifies timing budget and waits for reference time. Pre-registered as `CheckStartTime`
`REFERENCE_TIME_KEY`	Model	Key used to store/retrieve reference time in EnvironmentRun
`StepRegistry`	Model	Registry mapping names to step classes (pre-registers built-in timing steps)
`EnvironmentRun`	Model	Run-wide shared state
`EnvironmentTestcase`	Model	Per-testcase state
`Runner`	Runner Server	Suite execution engine
`StepCheck`	Check	Result comparison step
`LogAdapterConsole`	Log Adapter	Colored console output
`LogAdapterConsoleJson`	Log Adapter	JSON console output
`LogAdapterFile`	Log Adapter	File-based logging
`LogAdapterMemory`	Log Adapter	In-memory logging (testing)

Detailed Documentation

For detailed usage of each API, see the guide pages:

Configuration — loadConfig(), StepSetupConfig
Step Types — StepNormal, StepSingle, StepTimed
Execution — Runner, Suite Builder, Progress
Check & Results — StepCheck, Comparison
Logging — Log Adapters, Log Levels