RegisterMongoPluginsOptionsType

RegisterMongoPluginsOptionsType = object

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

Properties

client?

readonly optional client?: MongoClientLike

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

Shared client injected into all three stores — the usual case, since a MongoClient is a connection pool in its own right and they target the same deployment. When omitted, each store lazily builds its own from its url.

---

clientOptions?

readonly optional clientOptions?: Record<string, unknown>

Defined in: src/persistence/journals/MongoPluginOptions.ts:20

MongoClient options applied to every store that does not set its own.

---

databaseName?

readonly optional databaseName?: string

Defined in: src/persistence/journals/MongoPluginOptions.ts:18

Database name applied to every store that does not set its own.

---

durableStateStore?

readonly optional durableStateStore?: MongoDurableStateStoreOptions

Defined in: src/persistence/journals/MongoPluginOptions.ts:28

Durable-state-store-specific options (collection name).

---

journal?

readonly optional journal?: MongoJournalOptions

Defined in: src/persistence/journals/MongoPluginOptions.ts:24

Journal-specific options (collection name, autoCreateIndexes).

---

serializer?

readonly optional serializer?: Serializer

Defined in: src/persistence/journals/MongoPluginOptions.ts:22

Shared payload serializer applied to every store that does not set its own.

---

snapshotStore?

readonly optional snapshotStore?: MongoSnapshotStoreOptions

Defined in: src/persistence/journals/MongoPluginOptions.ts:26

Snapshot-store-specific options (collection name, keepN).

---

url?

readonly optional url?: string

Defined in: src/persistence/journals/MongoPluginOptions.ts:16

Connection string applied to every store that does not set its own.