Evento
Class Evento
Evento
Basic class handle event listeners.
All Known Subclasses
Constructor
Evento();
Properties
| Prop | Type | Default | Description |
|---|---|---|---|
| events | Record<string, EventElement> | {} | An object that contains all events for current instance. |
type EventHandler = (...args: any[]) => any;
type EventOptions = {
// Make the event persitance regardless of calling the `off` method
noOff?: boolean;
};
type EventElement = {
handlers: EventHandler[];
options?: EventOptions;
};
Methods
emit
Trigger the registered event.
Signatures
emit(name: string, ...args: any[]): Evento;
Parameters
- name - The event name. It can be namespaced by adding the colon after event name like this
click:namespace, then you can remove or trigger all the events that only belong to this namespace. - ...args - All checked datas.
Returns
Eventoinstance
once
Register a one time call event handler.
Signatures
once(name: string, handler: EventHandler): Evento;
Parameters
- name - The event name. It can be namespaced by adding the colon after event name like this
click:namespace, then you can remove or trigger all the events that only belong to this namespace. - handler - The event handler function.
Returns
Eventoinstance
on
Register an event handler.
Signatures
on(name: string, handler: EventHandler, options?: EventOptions): Evento;
Parameters
- name - The event name. It can be namespaced by adding the colon after event name like this
click:namespace, then you can remove or trigger all the events that only belong to this namespace. - handler - The event handler function.
- options - The event handler function.
type EventOptions = {
// Make the event can not be off with the `off` method
noOff?: boolean;
};
Returns
Eventoinstance
off
Un-register an event handler.
Signatures
off(name: string, handler?: EventHandler): Evento;
Parameters
- name - The event name. It can be namespaced by adding the colon after event name like this
click:namespace, then you can remove or trigger all the events that only belong to this namespace. - handler - The event handler function.
Returns
Eventoinstance