Skip to content

Latest commit

 

History

History
149 lines (83 loc) · 3.62 KB

core_event_emmiter.Internals.CustomEventEmmiter.md

File metadata and controls

149 lines (83 loc) · 3.62 KB

medusa-extender / Exports / core/event-emmiter / Internals / CustomEventEmmiter

Class: CustomEventEmmiter

core/event-emmiter.Internals.CustomEventEmmiter

Extended event emitter to register methods that must be call when certain events are triggered and relay the handling to the API package

Hierarchy

  • EventEmitter

    CustomEventEmmiter

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new CustomEventEmmiter()

Overrides

EventEmitter.constructor

Defined in

src/core/event-emmiter.ts:21

Properties

#listeners

Private #listeners: Set<ListenerDescriptor<unknown>>

Defined in

src/core/event-emmiter.ts:19

Methods

emitAsync

emitAsync<T>(eventName, values): Promise<T>

Emit an asynchrone event entity based and wait for the result.

Type parameters

Name
T

Parameters

Name Type Description
eventName string | symbol The event that must be triggered
values Record<string, unknown> The data that are passed to the event handler

Returns

Promise<T>

Defined in

src/core/event-emmiter.ts:80


register

register<T>(eventName, propertyName, metatype): void

Register a new event handler.

Type parameters

Name
T

Parameters

Name Type Description
eventName string | symbol The name of the event that has to be triggered
propertyName string The name of the class property that will handle the event
metatype Type<T> The object that contains the property above

Returns

void

Defined in

src/core/event-emmiter.ts:31


registerListeners

registerListeners(container): void

Apply all event handlers hold by the listenerDescriptor.

Parameters

Name Type Description
container AwilixContainer<any> The IoC container that allow to resolve instance

Returns

void

Defined in

src/core/event-emmiter.ts:43


unregisterListeners

unregisterListeners(): void

Returns

void

Defined in

src/core/event-emmiter.ts:68