Skip to main content
Version: 2.x

Class: BursarRuntime

Defined in: javascript/src/storage/runtime.ts:187

Node composition root for Bursar's stores and optional data infrastructure.

Without S3 or ClickHouse it constructs the same PostgreSQL-only Bursar and no outbox polling loop. Tenant and operator work always use distinct pools.

Properties​

billingStore​

readonly billingStore: PostgresBillingStore

Defined in: javascript/src/storage/runtime.ts:190


bursar​

readonly bursar: Bursar

Defined in: javascript/src/storage/runtime.ts:188


clickhouse​

readonly clickhouse: UsageEventSink & UsageAnalyticsStore | null

Defined in: javascript/src/storage/runtime.ts:195


creditStore​

readonly creditStore: PostgresStore

Defined in: javascript/src/storage/runtime.ts:189


maintenance​

readonly maintenance: BursarMaintenance

Defined in: javascript/src/storage/runtime.ts:191


operatorMaintenance​

readonly operatorMaintenance: BursarOperatorMaintenance

Defined in: javascript/src/storage/runtime.ts:192


outboxRecovery​

readonly outboxRecovery: OutboxRecoveryStore

Defined in: javascript/src/storage/runtime.ts:194


providerEnvironment​

readonly providerEnvironment: "live" | "test" | "sandbox"

Defined in: javascript/src/storage/runtime.ts:208


s3​

readonly s3: BillingPayloadArchive | null

Defined in: javascript/src/storage/runtime.ts:196


worker​

readonly worker: OutboxWorker | null

Defined in: javascript/src/storage/runtime.ts:193

Methods​

checkDependencies()​

checkDependencies(options?): Promise<BursarRuntimeDiagnostics>

Defined in: javascript/src/storage/runtime.ts:477

Parameters​

options?​

CheckDependenciesOptions = {}

Returns​

Promise<BursarRuntimeDiagnostics>


close()​

close(): Promise<void>

Defined in: javascript/src/storage/runtime.ts:507

Returns​

Promise<void>


flush()​

flush(): Promise<OutboxRunResult>

Defined in: javascript/src/storage/runtime.ts:501

Returns​

Promise<OutboxRunResult>


health()​

health(): BursarRuntimeHealth

Defined in: javascript/src/storage/runtime.ts:488

Returns​

BursarRuntimeHealth


start()​

start(options?): Promise<void>

Defined in: javascript/src/storage/runtime.ts:431

Parameters​

options?​

BursarRuntimeStartOptions = {}

Returns​

Promise<void>


state()​

state(): BursarRuntimeState

Defined in: javascript/src/storage/runtime.ts:469

Returns​

BursarRuntimeState


create()​

static create(options): Promise<BursarRuntime>

Defined in: javascript/src/storage/runtime.ts:215

Construct a runtime while keeping pool ownership inside the SDK.

Parameters​

options​

BursarRuntimeOptions

Returns​

Promise<BursarRuntime>