Class: InvitationGetUserEventAsync
Abstract async event class.
To create a custom async event, extend the EventAsync class.
You can override and customize the [payload]Event#payload getter if desired. Please read the documentation for the abstract Event class for the complete documentation.
For synchronous events, see the EventSync abstract class.
Example
// event payload type
type MyPayloadType = {id: number, active: boolean};
// event class
class MyEvent extends EventAsync<MyPayloadType> {}
// create an event
const myEvent = new MyEvent({id: 1234, active: true});Extends
Constructors
new InvitationGetUserEventAsync()
new InvitationGetUserEventAsync(
payload?):InvitationGetUserEventAsync
Constructor
Parameters
| Parameter | Type |
|---|---|
payload? | InvitationGetUserEventPayloadInterface |
Returns
Param
Payload to emit when the event is dispatched.
Inherited from
Defined in
packages/nestjs-event/dist/events/event.d.ts:8
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
expectsReturnOf | readonly | Promise<InvitationGetUserEventResponseInterface> | Internal Expects return of payload | EventAsync.expectsReturnOf |
Accessors
key
getkey():string
Event key.
Returns
string
The event key string.
Inherited from
Defined in
packages/nestjs-event/dist/events/event.d.ts:6
payload
getpayload():P
Returns payload that was passed to the Event constructor.
Returns
P
The event payload.
Inherited from
Defined in
packages/nestjs-event/dist/events/event.d.ts:9
key
getstatickey():string
Event key.
Returns
string
The event key string.
Inherited from
Defined in
packages/nestjs-event/dist/events/event.d.ts:5