Documentation / @ripl/core / Event
Class: Event<TData> ​
Defined in: packages/core/src/core/event-bus.ts:58
An event object carrying type, data, target reference, and propagation control.
Type Parameters ​
| Type Parameter | Default type |
|---|---|
TData | undefined |
Constructors ​
Constructor ​
new Event<
TData>(type,target,options?):Event<TData>
Defined in: packages/core/src/core/event-bus.ts:78
Parameters ​
| Parameter | Type |
|---|---|
type | string |
target | EventBus<any> |
options? | EventOptions<TData> |
Returns ​
Event<TData>
Properties ​
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
data | readonly | TData | The payload carried by this event. | packages/core/src/core/event-bus.ts:65 |
target | readonly | EventBus<any> | The EventBus on which the event was originally emitted. | packages/core/src/core/event-bus.ts:70 |
timestamp | readonly | number | The high-resolution timestamp at which the event was created. | packages/core/src/core/event-bus.ts:67 |
type | readonly | string | The event type name. | packages/core/src/core/event-bus.ts:63 |
Accessors ​
bubbles ​
Get Signature ​
get bubbles():
boolean
Defined in: packages/core/src/core/event-bus.ts:73
Whether this event will continue to bubble up the parent chain.
Returns ​
boolean
Methods ​
stopPropagation() ​
stopPropagation():
void
Defined in: packages/core/src/core/event-bus.ts:92
Prevents this event from bubbling further up the parent chain.
Returns ​
void