Skip to content

Documentation / @tenancy-node/core / EventsApi

Interface: EventsApi ​

Defined in: core/src/tenancy.ts:262

Properties ​

source ​

readonly source: string

Defined in: core/src/tenancy.ts:289

source de los CloudEvents que salen (tenancy-node://tuapp.com).

Methods ​

define() ​

define(type, schema): void

Defined in: core/src/tenancy.ts:285

Valida el data de un evento propio con un esquema Valibot al publicarlo.

Parameters ​

type ​

string

schema ​

GenericSchema

Returns ​

void


flush() ​

flush(): Promise<void>

Defined in: core/src/tenancy.ts:277

Espera a que terminen los listeners async en curso.

Returns ​

Promise<void>


forward() ​

forward(pattern, options): () => void

Defined in: core/src/tenancy.ts:283

Envía los eventos que coinciden con pattern a uno o más transportes (webhook, RabbitMQ...). Con outbox, el evento se guarda antes de enviarse (no se pierde si el transporte está caído). '*' no incluye tenancy.initialized/ended (uno por petición); reenvíalos de forma explícita si los necesitas.

Parameters ​

pattern ​

string

options ​

ForwardOptions

Returns ​

() => void


on() ​

Call Signature ​

on<K>(type, listener, options?): () => void

Defined in: core/src/tenancy.ts:263

Type Parameters ​
K ​

K extends keyof TenancyEventMap

Parameters ​
type ​

K

listener ​

EventListener<TenancyEventMap[K], K>

options? ​

EventListenerOptions

Returns ​

() => void

Call Signature ​

on(pattern, listener, options?): () => void

Defined in: core/src/tenancy.ts:269

Eventos propios de la app o patrones con comodín (tenant.*, *).

Parameters ​
pattern ​

string

listener ​

EventListener

options? ​

EventListenerOptions

Returns ​

() => void


publish() ​

Call Signature ​

publish<K>(type, data): Promise<EventEnvelope<TenancyEventMap[K], K>>

Defined in: core/src/tenancy.ts:271

Publica un evento propio; el tenantId se toma del contexto actual.

Type Parameters ​
K ​

K extends keyof TenancyEventMap

Parameters ​
type ​

K

data ​

TenancyEventMap[K]

Returns ​

Promise<EventEnvelope<TenancyEventMap[K], K>>

Call Signature ​

publish(type, data): Promise<EventEnvelope<unknown, string>>

Defined in: core/src/tenancy.ts:275

Parameters ​
type ​

string

data ​

unknown

Returns ​

Promise<EventEnvelope<unknown, string>>


transport() ​

transport(name): EventTransport | undefined

Defined in: core/src/tenancy.ts:287

Transporte registrado por nombre.

Parameters ​

name ​

string

Returns ​

EventTransport | undefined

Publicado bajo la licencia MIT.