ambiten

---

ambiten / core/src / AmbitenModelOptions

Interface: AmbitenModelOptions<T>

Defined in: packages/core/src/types/ambiten.model.type.ts:17

Options for configuring an Ambiten model.

Type Parameters

T

T extends Document = any

The type of the document in the model.

Properties

Ambiten?

optional Ambiten?: AmbitenClient

Defined in: packages/core/src/types/ambiten.model.type.ts:20

---

collection?

optional collection?: Collection<T>

Defined in: packages/core/src/types/ambiten.model.type.ts:23

---

collectionName

collectionName: string

Defined in: packages/core/src/types/ambiten.model.type.ts:18

---

ctx?

optional ctx?: ModelContext

Defined in: packages/core/src/types/ambiten.model.type.ts:22

---

gcConfig?

optional gcConfig?: object

Defined in: packages/core/src/types/ambiten.model.type.ts:24

createdAtField?

optional createdAtField?: string

enableGC?

optional enableGC?: boolean

field?

optional field?: string

indexName?

optional indexName?: string

ttl

ttl: number

updatedAtField?

optional updatedAtField?: string

---

provider?

optional provider?: DbProvider

Defined in: packages/core/src/types/ambiten.model.type.ts:21

---

schema?

optional schema?: AmbitenSchema<T>

Defined in: packages/core/src/types/ambiten.model.type.ts:19