Skip to main content

AsyncEvent

@webda/async

Class: AsyncEvent

Defined in: packages/async/src/services/asyncevents.service.ts:7

AsyncEvent representation

Constructors​

Constructor​

new AsyncEvent(service, type, payload?): AsyncEvent

Defined in: packages/async/src/services/asyncevents.service.ts:35

Parameters​

service​

string | ModelClass<Storable<any, any>> | Service<ServiceParameters, { }>

the emitter: a service, a model class or its serialized name

type​

string

the event type

payload?​

any = {}

the event payload

Returns​

AsyncEvent

Properties​

payload​

payload: any

Defined in: packages/async/src/services/asyncevents.service.ts:19

Payload of the event

service​

service: string

Defined in: packages/async/src/services/asyncevents.service.ts:11

Service emitted the event

time​

time: Date

Defined in: packages/async/src/services/asyncevents.service.ts:23

Time

type​

type: string

Defined in: packages/async/src/services/asyncevents.service.ts:15

Type of event

ServiceTag​

static ServiceTag: string = "#Webda:Service:"

Defined in: packages/async/src/services/asyncevents.service.ts:28

Used when serializing a service

Methods​

getMapper()​

getMapper(): string

Defined in: packages/async/src/services/asyncevents.service.ts:94

Mapper name

Returns​

string

the mapper key

toJSON()​

toJSON(): AsyncEvent & object

Defined in: packages/async/src/services/asyncevents.service.ts:55

Allow payload to contain Service but do not serialize them replacing them by a #Webda:Service:${service.getName()} so it can be revived

Returns​

AsyncEvent & object

the serializable event

fromQueue()​

static fromQueue(data): AsyncEvent

Defined in: packages/async/src/services/asyncevents.service.ts:75

Deserialize from the queue, reviving any detected service

Parameters​

data​

any

the serialized event

Returns​

AsyncEvent

the event