Interface: PostgresBillingStoreOptions

Defined in: javascript/src/billing/postgres/store.ts:135

Extends

• Omit<PostgresConnectionOptions, "providerEnvironment">

Properties

applicationName?

optional applicationName?: string

Defined in: javascript/src/shared/postgres-client.ts:72

PostgreSQL application_name. Defaults to bursar-js.

Inherited from

PostgresStoreOptions.applicationName

---

billingPayloadBackend?

optional billingPayloadBackend?: "postgres" | "s3"

Defined in: javascript/src/billing/postgres/store.ts:147

---

connectionTimeoutMs?

optional connectionTimeoutMs?: number

Defined in: javascript/src/shared/postgres-client.ts:62

Time allowed to establish or acquire a connection. Defaults to 10 seconds.

Inherited from

PostgresStoreOptions.connectionTimeoutMs

---

idleTimeoutMs?

optional idleTimeoutMs?: number

Defined in: javascript/src/shared/postgres-client.ts:68

Idle pooled connection lifetime. Uses pg's default when omitted.

Inherited from

PostgresStoreOptions.idleTimeoutMs

---

idleTransactionTimeoutMs?

optional idleTransactionTimeoutMs?: number

Defined in: javascript/src/shared/postgres-client.ts:66

Server-side idle transaction deadline. Defaults to 30 seconds; set 0 to disable.

Inherited from

PostgresStoreOptions.idleTransactionTimeoutMs

---

instrumentation?

optional instrumentation?: Instrumentation

Defined in: javascript/src/shared/postgres-client.ts:76

Optional vendor-neutral instrumentation. Defaults to Bursar's no-op registry.

Inherited from

PostgresStoreOptions.instrumentation

---

maxConnections?

optional maxConnections?: number

Defined in: javascript/src/shared/postgres-client.ts:70

Maximum connections in an SDK-owned pool. Uses pg's default when omitted.

Inherited from

PostgresStoreOptions.maxConnections

---

onPoolError?

optional onPoolError?: (error) => void

Defined in: javascript/src/shared/postgres-client.ts:74

Receives typed errors emitted by idle pool clients. Must not throw.

Parameters

error

BursarError

Returns

void

Inherited from

PostgresStoreOptions.onPoolError

---

poolConstructor?

optional poolConstructor?: PostgresPoolConstructor

Defined in: javascript/src/billing/postgres/store.ts:146

Injectable pg.Pool constructor for custom runtimes and tests.

---

postgres

postgres: string | PostgresPool

Defined in: javascript/src/billing/postgres/store.ts:140

PostgreSQL connection string or an application-owned pool.

---

providerEnvironment

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

Defined in: javascript/src/billing/postgres/store.ts:144

Explicit financial namespace; billing stores never guess live vs test.

---

statementTimeoutMs?

optional statementTimeoutMs?: number

Defined in: javascript/src/shared/postgres-client.ts:64

Server-side statement deadline. Defaults to 30 seconds; set 0 to disable.

Inherited from

PostgresStoreOptions.statementTimeoutMs

---

tenantId

tenantId: string

Defined in: javascript/src/billing/postgres/store.ts:142

Tenant UUID bound to every store transaction.