EventEmitOptions
interface exported by @mwillbanks/tuil-events.
interface
Public interface exported by @mwillbanks/tuil-events.
export interface EventEmitOptions {
readonly source?: EventSource;
readonly target?: EventTarget;
readonly metadata?: Readonly<Record<string, unknown>>;
readonly priority?: EventPriority;
readonly path?: readonly string[];
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
source | EventSource | undefined | No | The source member uses the EventSource | undefined contract. | EventSource |
target | EventTarget | undefined | No | The target member uses the EventTarget | undefined contract. | EventTarget |
metadata | Readonly<Record<string, unknown>> | undefined | No | The metadata member uses the Readonly<Record<string, unknown>> | undefined contract. | — |
priority | EventPriority | undefined | No | The priority member uses the EventPriority | undefined contract. | EventPriority |
path | readonly string[] | undefined | No | The path member uses the readonly string[] | undefined contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference