Documentation / @tenancy-node/core / FeaturesApi
Interface: FeaturesApi
Defined in: core/src/tenancy.ts:183
Módulos y límites del plan. Sin tenant, usan el del contexto actual (y lanzan TenantNotIdentifiedError en el contexto central).
Properties
enabled
readonlyenabled:boolean
Defined in: core/src/tenancy.ts:185
false sin plans en la configuración: entonces todo tenant tiene todos los módulos.
Methods
assertLimit()
assertLimit(
name,current,tenant?):void
Defined in: core/src/tenancy.ts:200
Antes de crear uno más: lanza PlanLimitReachedError (403) si current ya llegó al límite. current lo cuenta tu app (la librería no conoce tus tablas).
Parameters
name
string
current
number
tenant?
Returns
void
catalog()
catalog():
FeatureInfo[]
Defined in: core/src/tenancy.ts:204
Catálogo de módulos de la configuración.
Returns
has()
has(
feature,tenant?):boolean
Defined in: core/src/tenancy.ts:187
¿El plan del tenant (más sus módulos sueltos) incluye el módulo?
Parameters
feature
string
tenant?
Returns
boolean
limit()
limit(
name,tenant?):number|null
Defined in: core/src/tenancy.ts:193
Límite efectivo (null = sin límite).
Parameters
name
string
tenant?
Returns
number | null
list()
list(
tenant?):string[]
Defined in: core/src/tenancy.ts:191
Módulos efectivos, en el orden del catálogo.
Parameters
tenant?
Returns
string[]
of()
of(
tenant?):ResolvedFeatures
Defined in: core/src/tenancy.ts:202
Plan, módulos y límites efectivos.
Parameters
tenant?
Returns
remaining()
remaining(
name,current,tenant?):number|null
Defined in: core/src/tenancy.ts:195
Cuántos quedan antes del límite (null = sin límite).
Parameters
name
string
current
number
tenant?
Returns
number | null
require()
require(
feature,tenant?):void
Defined in: core/src/tenancy.ts:189
Lanza FeatureNotInPlanError (403) si falta alguno de los módulos.
Parameters
feature
string | readonly string[]
tenant?
Returns
void