ambiten

---

ambiten / core/src / AmbitenRuntime

Interface: AmbitenRuntime<T>

Defined in: packages/core/src/types/ambiten-runtime-type.ts:13

Type Parameters

T

T extends Document = Document

Methods

cache()

cache<T>(key, fetcher, options?): Promise<T>

Defined in: packages/core/src/types/ambiten-runtime-type.ts:34

Type Parameters

T

T

Parameters

key

string

fetcher

() => Promise<T>

options?

AmbitenCacheOptions

Returns

Promise<T>

---

getGCRunner()

getGCRunner(): AmbitenGC | undefined

Defined in: packages/core/src/types/ambiten-runtime-type.ts:26

Returns

AmbitenGC | undefined

---

getGraphQL()

getGraphQL(): AmbitenGraphQL | undefined

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

Returns

AmbitenGraphQL | undefined

---

getLogger()

getLogger(): ILogger

Defined in: packages/core/src/types/ambiten-runtime-type.ts:27

Returns

ILogger

---

getModel()

getModel(): AmbitenModel<T>

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

Returns

AmbitenModel<T>

---

getMongoClient()

getMongoClient(): AmbitenClient | BootstrapClient

Defined in: packages/core/src/types/ambiten-runtime-type.ts:14

Returns

AmbitenClient | BootstrapClient

---

getSchema()

getSchema(): AmbitenSchema<T>

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

Returns

AmbitenSchema<T>

---

invalidateCache()

invalidateCache(tenantId, namespace?): Promise<void>

Defined in: packages/core/src/types/ambiten-runtime-type.ts:40

Parameters

tenantId

string

namespace?

string

Returns

Promise<void>

---

onConnect()

onConnect(callback): void

Defined in: packages/core/src/types/ambiten-runtime-type.ts:16

Parameters

callback

() => void | Promise<void>

Returns

void

---

registerMultiTenancy()

registerMultiTenancy(options): Promise<void>

Defined in: packages/core/src/types/ambiten-runtime-type.ts:29

Parameters

options

lazy?

boolean

tenants?

Record<string, string>

Returns

Promise<void>

---

shutdown()

shutdown(): Promise<void>

Defined in: packages/core/src/types/ambiten-runtime-type.ts:45

Returns

Promise<void>