basalt / tenancy/src / TenancyOptions
Interface: TenancyOptions
Defined in: tenancy/src/index.ts:102
Everything new Tenancy() takes, by name. tenancyPlugin builds the facade for you; construct it directly only for a test or a script that runs without the plugin.
Properties
canonicalDomain?
> optional canonicalDomain?: (tenant) => string | undefined
Defined in: tenancy/src/index.ts:114
See TenancyPluginOptions.canonicalDomain.
Parameters
tenant
Returns
string | undefined
hooks?
> optional hooks?: HookBus
Defined in: tenancy/src/index.ts:106
Where tenancy:created, tenancy:destroyed and tenancy:switched are emitted.
onConflict?
> optional onConflict?: ResolverConflictPolicy
Defined in: tenancy/src/index.ts:121
How resolve() treats resolvers that name different tenants. Default 'precedence'.
onDeprovision?
> optional onDeprovision?: (tenant) => void | Promise<void>
Defined in: tenancy/src/index.ts:112
See TenancyPluginOptions.onDeprovision.
Parameters
tenant
Returns
void | Promise<void>
onProvision?
> optional onProvision?: (tenant) => void | Promise<void>
Defined in: tenancy/src/index.ts:108
See TenancyPluginOptions.onProvision.
Parameters
tenant
Returns
void | Promise<void>
provisionMode?
> optional provisionMode?: "inline" | "deferred"
Defined in: tenancy/src/index.ts:110
'deferred' → create() returns before provisioning; see provision(). Default 'inline'.
resolvers
> resolvers: TenantResolver[]
Defined in: tenancy/src/index.ts:104
source
> source: TenantSource
Defined in: tenancy/src/index.ts:103
validateTenantId?
> optional validateTenantId?: (id) => boolean
Defined in: tenancy/src/index.ts:119
The tenant-id grammar create(), run() and resolve() enforce. Default isValidTenantId.
Parameters
id
string
Returns
boolean