D1JournalOptionsType

Defined in: src/persistence/journals/D1JournalOptions.ts:8

Extends

• D1OptionsBaseType

Properties

accountId?

readonly optional accountId?: string

Defined in: src/persistence/journals/D1Client.ts:49

Cloudflare account id. Required unless client is supplied.

Inherited from

D1OptionsBaseType.accountId

---

apiToken?

readonly optional apiToken?: string

Defined in: src/persistence/journals/D1Client.ts:57

API token with the D1:Edit permission. Sent as a bearer token, so treat it like any other secret — read it from the environment rather than committing it.

Inherited from

D1OptionsBaseType.apiToken

---

autoCreateTables?

readonly optional autoCreateTables?: boolean

Defined in: src/persistence/journals/D1JournalOptions.ts:14

Run CREATE TABLE IF NOT EXISTS on first use. Default: true.

---

baseUrl?

readonly optional baseUrl?: string

Defined in: src/persistence/journals/D1Client.ts:59

API base URL. Override only for a proxy or a test double.

Inherited from

D1OptionsBaseType.baseUrl

---

client?

readonly optional client?: D1ClientLike

Defined in: src/persistence/journals/D1Client.ts:67

Pre-built transport — bypasses the HTTP client entirely. Use to share ONE transport across the journal, snapshot and durable-state stores (see registerD1Plugins), or to inject a fake in tests.

Inherited from

D1OptionsBaseType.client

---

databaseId?

readonly optional databaseId?: string

Defined in: src/persistence/journals/D1Client.ts:51

D1 database id (the UUID, not the database name).

Inherited from

D1OptionsBaseType.databaseId

---

eventsTable?

readonly optional eventsTable?: string

Defined in: src/persistence/journals/D1JournalOptions.ts:10

Events table name. Default: events.

---

serializer?

readonly optional serializer?: Serializer<unknown>

Defined in: src/persistence/storage/StoreSerializerOptions.ts:23

Custom payload serializer. When set, the store writes rows in the self-describing __serialized__ framing (see PayloadCodec) instead of the default tagged JSON; rows of both formats can coexist in one stream, but reading a framed row back requires a serializer with the same id to be configured.

Inherited from

D1OptionsBaseType.serializer

---

tagsTable?

readonly optional tagsTable?: string

Defined in: src/persistence/journals/D1JournalOptions.ts:12

Tags join table name. Default: ${eventsTable}_tags.

---

timeoutMs?

readonly optional timeoutMs?: number

Defined in: src/persistence/journals/D1Client.ts:61

Per-request timeout in milliseconds. Default 30 000.

Inherited from

D1OptionsBaseType.timeoutMs