Class PreventableBaklavaEvent<T, E>

Extension for the BaklavaEvent class. A listener can return false to prevent this event from happening.

Type Parameters

T
E

Hierarchy (view full)

Subscribable<PreventableEventListener<T, E>>
- PreventableBaklavaEvent

Index

Constructors

Properties

Accessors

Methods

emit registerProxy subscribe unregisterProxy unsubscribe

Constructors

constructor

new PreventableBaklavaEvent<T, E>(entity): PreventableBaklavaEvent<T, E>
Type Parameters
- T
- E
Parameters
- entity: E
Returns PreventableBaklavaEvent<T, E>
Overrides Subscribable.constructor
- Defined in events/src/event.ts:30

Properties

`Protected` `Readonly` entity

entity: E

Accessors

listeners

get listeners(): F[]
Returns F[]
Inherited from Subscribable.listeners
- Defined in events/src/subscribable.ts:12

Methods

emit

emit(data): {
prevented: boolean;
}
Invoke all listeners.
Parameters
- data: T
  The data to invoke all listeners with
Returns {
prevented: boolean;
}
An object, where the prevented field is true when one of the listeners requested to prevent the event, otherwise false
- prevented: boolean
- Defined in events/src/event.ts:39

registerProxy

registerProxy(token, getListeners): void
This function is only used internally for proxies
Parameters
- token: any
- getListeners: GetListenersFn<PreventableEventListener<T, E>>
Returns void
Inherited from Subscribable.registerProxy
- Defined in events/src/subscribable.ts:51

subscribe

subscribe(token, callback): void
Subscribe to the event / hook
Parameters
- token: any
  A token that can be used to unsubscribe from the event / hook later on
- callback: PreventableEventListener<T, E>
  A callback that will be invoked when the event / hook occurs
Returns void
Inherited from Subscribable.subscribe
- Defined in events/src/subscribable.ts:21

unregisterProxy

unregisterProxy(token): void
This function is only used internally for proxies
Parameters
- token: any
Returns void
Inherited from Subscribable.unregisterProxy
- Defined in events/src/subscribable.ts:65

unsubscribe

unsubscribe(token): void
Remove a listener
Parameters
- token: any
  The token that was specified when subscribing to the listener. An invalid token does not result in an error.
Returns void
Inherited from Subscribable.unsubscribe
- Defined in events/src/subscribable.ts:39