Skip to main content

getTenantModel

@abimongo/core v1.1.4


@abimongo/core / getTenantModel

Function: getTenantModel()

getTenantModel<T>(param): Promise<any>

Defined in: core/src/tanancy/TenantModelResolver.ts:56

Resolves a tenant-specific model by creating or retrieving it from the cache. Ensures that each tenant has its own isolated model instance.

Type Parameters

T

T extends Document

The type of the document in the model.

Parameters

param

GetTanantModelParams<T>

The parameters required to resolve the model.

Returns

Promise<any>

A promise that resolves to the tenant-specific model instance.

Throws

If no tenant context is found or the tenant is not registered.

Examples

const userModel = await getTenantModel({
modelName: 'User',
schema: UserSchema,
tenantId: 'tenant123'
});
// userModel is now a tenant-specific model for the 'User' collection in 'tenant123'
const productModel = await getTenantModel({
modelName: 'Product',
schema: ProductSchema,
tenantId: 'tenant456'
});