ambiten

---

ambiten / core / AmbitenConfig

Interface: AmbitenConfig

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

Properties

advanced?

optional advanced?: object

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

Advanced runtime configuration.

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:114

Optional config metadata/versioning. Useful for generated config files and forward compatibility.

---

connection?

optional connection?: object

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

Connection settings used when no provider/mongoClient is supplied.

options?

optional options?: Record<string, any>

uri

uri: string

---

features?

optional features?: object

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

Optional feature paths and integrations. These are especially useful for generated project structures and bootstrap discovery.

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:73

Optional GraphQL auto-generation/bootstrap feature. Primarily useful for playgrounds, prototyping, and generated GraphQL flows.

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:67

Logger configuration.

---

model?

optional model?: AmbitenModelOptions<any>

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

Optional default model/schema bootstrap config. These are runtime-facing defaults, not request resolver functions.

---

mongoClient?

optional mongoClient?: BootstrapClient

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

---

multiTenant?

optional multiTenant?: object

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

Multi-tenant runtime configuration.

enabled?

optional enabled?: boolean

headerKey?

optional headerKey?: string

initOptions?

optional initOptions?: InitMultiTenancyOptions

tenants?

optional tenants?: Record<string, string>

---

projectName?

optional projectName?: string

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

---

provider?

optional provider?: BootstrapClient

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

Optional externally provided bootstrap client/provider. If provided, bootstrap uses this instead of creating one from connection config.

---

schema?

optional schema?: SchemaDefinition<Document>

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