ambiten

---

ambiten / core/src / AmbitenConfig

Interface: AmbitenConfig<T>

Defined in: packages/core/src/types/ambitenConfig.ts:30

Type Parameters

T

T extends Document = any

Properties

advanced?

optional advanced?: object

Defined in: packages/core/src/types/ambitenConfig.ts:93

autoInstall?

optional autoInstall?: boolean

circuitBreaker?

optional circuitBreaker?: object

circuitBreaker.enabled?

optional enabled?: boolean

circuitBreaker.retryAttempts?

optional retryAttempts?: number

garbageCollector?

optional garbageCollector?: object

garbageCollector.enabled?

optional enabled?: boolean

garbageCollector.logResults?

optional logResults?: boolean

garbageCollector.retentionPeriod?

optional retentionPeriod?: string | number

gcCron?

optional gcCron?: string

---

configVersion?

optional configVersion?: string

Defined in: packages/core/src/types/ambitenConfig.ts:110

---

connection?

optional connection?: object

Defined in: packages/core/src/types/ambitenConfig.ts:38

options?

optional options?: Record<string, any>

uri

uri: string

---

features?

optional features?: object

Defined in: packages/core/src/types/ambitenConfig.ts:84

models?

optional models?: string

redisUri?

optional redisUri?: string

resolvers?

optional resolvers?: Record<string, any> | Record<string, any>[]

schemas?

optional schemas?: string

typeDefs?

optional typeDefs?: string

useRedisCache?

optional useRedisCache?: boolean

---

graphql?

optional graphql?: object

Defined in: packages/core/src/types/ambitenConfig.ts:77

enabled?

optional enabled?: boolean

playground?

optional playground?: boolean

schemaOutputPath?

optional schemaOutputPath?: string

subscriptions?

optional subscriptions?: boolean

---

logger?

optional logger?: AmbitenLoggerSettings

Defined in: packages/core/src/types/ambitenConfig.ts:75

---

model?

optional model?: BootstrapModelOptions<T>

Defined in: packages/core/src/types/ambitenConfig.ts:43

---

mongoClient?

optional mongoClient?: BootstrapClient

Defined in: packages/core/src/types/ambitenConfig.ts:36

---

multiTenant?

optional multiTenant?: object

Defined in: packages/core/src/types/ambitenConfig.ts:47

enabled?

optional enabled?: boolean

headerKey?

optional headerKey?: string

Header used by supported runtime integrations to identify the active tenant.

Default

"x-tenant-id"

initOptions?

optional initOptions?: InitMultiTenancyOptions

tenantConfigResolver?

optional tenantConfigResolver?: TenantConfigResolver

Dynamically resolves configuration for tenants that are not already registered.

tenants?

optional tenants?: Record<string, string>

Static tenant ID → MongoDB URI mappings.

Useful for local development, tests, and applications with a known tenant set.

---

projectName?

optional projectName?: string

Defined in: packages/core/src/types/ambitenConfig.ts:33

---

provider?

optional provider?: BootstrapClient

Defined in: packages/core/src/types/ambitenConfig.ts:35

---

schema?

optional schema?: SchemaDefinition<T>

Defined in: packages/core/src/types/ambitenConfig.ts:45