Documentation / @tenancy-node/core / Tenant

Class: Tenant

Defined in: core/src/domain/entities/tenant.ts:65

Un tenant: un cliente de la aplicación con sus propios recursos aislados.

Properties

createdAt

readonly createdAt: Date

Defined in: core/src/domain/entities/tenant.ts:78

---

id

readonly id: TenantId

Defined in: core/src/domain/entities/tenant.ts:67

Accessors

data

Get Signature

get data(): Readonly<TenantData>

Defined in: core/src/domain/entities/tenant.ts:136

Returns

Readonly<TenantData>

---

database

Get Signature

get database(): Readonly<TenantDatabase> | null

Defined in: core/src/domain/entities/tenant.ts:142

Returns

Readonly<TenantDatabase> | null

---

deletedAt

Get Signature

get deletedAt(): Date | null

Defined in: core/src/domain/entities/tenant.ts:157

Returns

Date | null

---

features

Get Signature

get features(): Readonly<TenantFeatureOverrides> | null

Defined in: core/src/domain/entities/tenant.ts:133

Módulos sueltos y límites propios (sobre el plan).

Returns

Readonly<TenantFeatureOverrides> | null

---

isActive

Get Signature

get isActive(): boolean

Defined in: core/src/domain/entities/tenant.ts:160

Returns

boolean

---

isDeleted

Get Signature

get isDeleted(): boolean

Defined in: core/src/domain/entities/tenant.ts:163

Returns

boolean

---

maintenanceMessage

Get Signature

get maintenanceMessage(): string | null

Defined in: core/src/domain/entities/tenant.ts:145

Returns

string | null

---

name

Get Signature

get name(): string

Defined in: core/src/domain/entities/tenant.ts:123

Returns

string

---

plan

Get Signature

get plan(): string | null

Defined in: core/src/domain/entities/tenant.ts:129

Returns

string | null

---

provisionedAt

Get Signature

get provisionedAt(): Date | null

Defined in: core/src/domain/entities/tenant.ts:148

Returns

Date | null

---

status

Get Signature

get status(): "provisioning" | "active" | "maintenance" | "suspended" | "failed" | "deleting"

Defined in: core/src/domain/entities/tenant.ts:126

Returns

"provisioning" | "active" | "maintenance" | "suspended" | "failed" | "deleting"

---

suspendedAt

Get Signature

get suspendedAt(): Date | null

Defined in: core/src/domain/entities/tenant.ts:151

Returns

Date | null

---

theme

Get Signature

get theme(): Theme | null

Defined in: core/src/domain/entities/tenant.ts:139

Returns

Theme | null

---

updatedAt

Get Signature

get updatedAt(): Date

Defined in: core/src/domain/entities/tenant.ts:154

Returns

Date

Methods

activate()

activate(now): void

Defined in: core/src/domain/entities/tenant.ts:222

Parameters

now

Date

Returns

void

---

assignDatabase()

assignDatabase(database, now): void

Defined in: core/src/domain/entities/tenant.ts:204

Registra en qué servidor y base quedó el tenant.

Parameters

database

TenantDatabase

now

Date

Returns

void

---

changeTheme()

changeTheme(theme, now): void

Defined in: core/src/domain/entities/tenant.ts:198

Parameters

theme

Theme | null

now

Date

Returns

void

---

markDeleted()

markDeleted(now): void

Defined in: core/src/domain/entities/tenant.ts:242

Parameters

now

Date

Returns

void

---

markDeleting()

markDeleting(now): void

Defined in: core/src/domain/entities/tenant.ts:238

Parameters

now

Date

Returns

void

---

markFailed()

markFailed(now): void

Defined in: core/src/domain/entities/tenant.ts:218

Parameters

now

Date

Returns

void

---

markProvisioned()

markProvisioned(now): void

Defined in: core/src/domain/entities/tenant.ts:213

Parameters

now

Date

Returns

void

---

markProvisioning()

markProvisioning(now): void

Defined in: core/src/domain/entities/tenant.ts:209

Parameters

now

Date

Returns

void

---

putInMaintenance()

putInMaintenance(message, now): void

Defined in: core/src/domain/entities/tenant.ts:233

Parameters

message

string | null

now

Date

Returns

void

---

suspend()

suspend(now): void

Defined in: core/src/domain/entities/tenant.ts:228

Parameters

now

Date

Returns

void

---

toSnapshot()

toSnapshot(): TenantSnapshot

Defined in: core/src/domain/entities/tenant.ts:250

Returns

TenantSnapshot

---

update()

update(changes, now): string[]

Defined in: core/src/domain/entities/tenant.ts:168

Aplica cambios de datos. Devuelve la lista de campos que cambiaron.

Parameters

changes

TenantChanges

now

Date

Returns

string[]

---

create()

static create(props): Tenant

Defined in: core/src/domain/entities/tenant.ts:84

Crea un tenant nuevo en estado provisioning.

Parameters

props

CreateTenantProps

Returns

Tenant

---

restore()

static restore(snapshot): Tenant

Defined in: core/src/domain/entities/tenant.ts:104

Reconstruye un tenant guardado.

Parameters

snapshot

TenantSnapshot

Returns

Tenant