Skip to content

Event ​

O SDK exporta os tipos para trabalhar com eventos da plataforma:

ts
import type {
  EventCallback,
  EventCallbacks,
  EventEmitParams,
  EventInfo,
  EventParams,
  EventTarget
} from '@flowlu/miniapp-jssdk'

Tipos ​

EventCallback ​

Função de callback de evento

ts
type EventCallback<T = any> = (data: T) => void
ParâmetroTipoDescrição
dataanyDados do evento

EventCallbacks ​

Objeto com manipuladores de eventos, passado nos parâmetros do método e do construtor

ts
type EventCallbacks<TEventName extends string = string> =
  Partial<Record<TEventName, EventCallback<any> | null>> | null
PropriedadeTipoDescrição
[eventName: string]EventCallback | nullManipulador de evento

EventEmitParams ​

Parâmetros do método estático Event.emit()

PropriedadeTipoDescrição
targetEventTargetObjeto que identifica o evento-alvo na plataforma
infoEventInfoDados arbitrários do evento

EventInfo ​

Dados arbitrários do evento, passados no método Event.emit() e entregues aos manipuladores registrados via Event.on() e Event.once()

ts
type EventInfo = Record<string, any>
PropriedadeTipoDescrição
[key: string]anyDados arbitrários do evento

EventParams ​

Parâmetros do construtor de Event

PropriedadeTipoDescrição
targetEventTargetObjeto que identifica o evento-alvo na plataforma
eventsEventCallbacks<EventEventName>Manipuladores de eventos da instância

EventTarget ​

Objeto que identifica o evento-alvo na plataforma, usado na propriedade Event.target, no construtor de Event e no método estático Event.emit()

ts
type EventTarget = Record<string, any>
PropriedadeTipoDescrição
[key: string]anyDados arbitrários que identificam o evento

Publicado sob a licença MIT.