Eventos

Recursos diversos para trabalhar com eventos.

emitCustomEvent

Emite um evento customizado.

• Tipo

function emitCustomEvent<T>(type: string, detail?: T): void;

• Detalhes

Recebe o nome de um evento (type) e, opcionalmente, dados adicionais (detail) para anexar aos detalhes do evento que será emitido na página.

• Exemplo

import { emitCustomEvent } from "@nexdom/shared/utils";

const type = "custom-event";
const detail = { key: "value" };

// emite um CustomEvent, do tipo "custom-event", com o campo detail igual ao segundo parâmetro.
emitCustomEvent(type, detail);

listenEvent

Escuta um evento.

• Tipo

function listenEvent<K extends keyof WindowEventMap>(
  ...params: Parameters<typeof window.addEventListener<K>>
): () => void;

ou

function listenEvent(...params: Parameters<typeof window.addEventListener>): () => void;

• Detalhes

Recebe os mesmos parâmetros do método addEventListener e retorna uma função que irá remover o event listener.

• Exemplo

import { listenEvent } from "@nexdom/shared/utils";

const type = "custom-event";
const cb = (event: CustomEvent) => {
  // ...
};

// Adiciona um event listener.
const removeListener = listenEvent(type, cb);

removeListener

Remove a escuta de evento.

• Tipo

function removeListener<K extends keyof WindowEventMap>(
  ...params: Parameters<typeof window.removeEventListener<K>>
): void;

ou

function removeListener(...params: Parameters<typeof window.removeEventListener>): void;

• Detalhes

Recebe os mesmos parâmetros do método removeEventListener, para remover um event listener.

• Exemplo

import { removeListener } from "@nexdom/shared/utils";

const type = "custom-event";
const cb = (event: CustomEvent) => {
  // ...
};

// Remove um event listener.
removeListener(type, cb);