Skip to main content
Version: 2.x

Class: BursarRuntime

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

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:181


bursar

readonly bursar: Bursar

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


clickhouse

readonly clickhouse: UsageEventSink & UsageAnalyticsStore | null

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


creditStore

readonly creditStore: PostgresStore

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


maintenance

readonly maintenance: BursarMaintenance

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


operatorMaintenance

readonly operatorMaintenance: BursarOperatorMaintenance

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


outboxRecovery

readonly outboxRecovery: OutboxRecoveryStore

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


providerEnvironment

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

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


s3

readonly s3: BillingPayloadArchive | null

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


worker

readonly worker: OutboxWorker | null

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

Methods

checkDependencies()

checkDependencies(options?): Promise<BursarRuntimeDiagnostics>

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

Parameters

options?

CheckDependenciesOptions = {}

Returns

Promise<BursarRuntimeDiagnostics>


close()

close(): Promise<void>

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

Returns

Promise<void>


flush()

flush(): Promise<OutboxRunResult>

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

Returns

Promise<OutboxRunResult>


health()

health(): BursarRuntimeHealth

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

Returns

BursarRuntimeHealth


start()

start(options?): Promise<void>

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

Parameters

options?

BursarRuntimeStartOptions = {}

Returns

Promise<void>


state()

state(): BursarRuntimeState

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

Returns

BursarRuntimeState


create()

static create(options): Promise<BursarRuntime>

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

Construct a runtime while keeping pool ownership inside the SDK.

Parameters

options

BursarRuntimeOptions

Returns

Promise<BursarRuntime>