event

El sistema de eventos te permite emitir eventos al backend y escuchar eventos desde este.

Este paquete también es accesible mediante window.__TAURI__.event cuando app.withGlobalTauri en tauri.conf.json está configurado en true.

Enumeraciones

TauriEvent

Desde

1.1.0

Miembros de enumeraciones

DRAG_DROP

DRAG_DROP: "tauri://drag-drop";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L73

DRAG_ENTER

DRAG_ENTER: "tauri://drag-enter";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L71

DRAG_LEAVE

DRAG_LEAVE: "tauri://drag-leave";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L74

DRAG_OVER

DRAG_OVER: "tauri://drag-over";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L72

WEBVIEW_CREATED

WEBVIEW_CREATED: "tauri://webview-created";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L70

WINDOW_BLUR

WINDOW_BLUR: "tauri://blur";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L64

WINDOW_CLOSE_REQUESTED

WINDOW_CLOSE_REQUESTED: "tauri://close-requested";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L61

WINDOW_CREATED

WINDOW_CREATED: "tauri://window-created";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L67

WINDOW_DESTROYED

WINDOW_DESTROYED: "tauri://destroyed";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L62

WINDOW_FOCUS

WINDOW_FOCUS: "tauri://focus";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L63

WINDOW_MOVED

WINDOW_MOVED: "tauri://move";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L60

WINDOW_RESIZED

WINDOW_RESIZED: "tauri://resize";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L59

WINDOW_RESUMED

WINDOW_RESUMED: "tauri://resumed";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L69

WINDOW_SCALE_FACTOR_CHANGED

WINDOW_SCALE_FACTOR_CHANGED: "tauri://scale-change";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L65

WINDOW_SUSPENDED

WINDOW_SUSPENDED: "tauri://suspended";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L68

WINDOW_THEME_CHANGED

WINDOW_THEME_CHANGED: "tauri://theme-changed";

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L66

Interfaces

Event<T>

Parámetros de tipo

Parámetro de tipo
T

Propiedades

Propiedad	Tipo	Descripción	Definido en
event	EventName	Nombre del evento	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L32
id	number	Identificador de evento usado para dejar de escuchar (unlisten)	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L34
payload	T	Carga útil (payload) del evento	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L36

---

Opciones

Propiedades

Propiedad	Tipo	Descripción	Definido en
target?	string | EventTarget	El objetivo del evento (event target) a escuchar, por defecto es { kind: 'Any' }, consulta EventTarget. Si se proporciona una cadena, se usa EventTarget.AnyLabel.	Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L52

Alias de tipos

EventCallback()<T>

type EventCallback<T>: (event) => void;

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo
event	Event<T>

Devuelve

void

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L39

---

EventName

type EventName: `${TauriEvent}` | string & Record<never, never>;

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L44

---

EventTarget

type EventTarget:
  | object
  | object
  | object
  | object
  | object
  | object;

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L22

---

UnlistenFn()

type UnlistenFn: () => void;

Devuelve

void

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L42

Funciones

emit()

function emit<T>(event, payload?): Promise<void>

Emite un evento a todos los objetivos (targets).

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
event	string	Nombre del evento. Debe incluir solo caracteres alfanuméricos, -, /, : y _.
payload?	T	Carga útil (payload) del evento.

Devuelve

Promise<void>

Ejemplo

import { emit } from '@tauri-apps/api/event';
await emit('frontend-loaded', { loggedIn: true, token: 'authToken' });

Desde

1.0.0

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L188

---

emitTo()

function emitTo<T>(
   target,
   event,
payload?): Promise<void>

Emite un evento a todos los objetivos (targets) que coincidan con el objetivo dado.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
target	string | EventTarget	Etiqueta (label) de la Window/Webview/WebviewWindow de destino o un objeto EventTarget sin procesar.
event	string	Nombre del evento. Debe incluir solo caracteres alfanuméricos, -, /, : y _.
payload?	T	Carga útil (payload) del evento.

Devuelve

Promise<void>

Ejemplo

import { emitTo } from '@tauri-apps/api/event';
await emitTo('main', 'frontend-loaded', { loggedIn: true, token: 'authToken' });

Desde

2.0.0

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L210

---

listen()

function listen<T>(
   event,
   handler,
options?): Promise<UnlistenFn>

Escucha un evento emitido para cualquier objetivo (target).

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
event	EventName	Nombre del evento. Debe incluir solo caracteres alfanuméricos, -, /, : y _.
handler	EventCallback<T>	Callback del manejador de eventos.
options?	Opciones	Opciones de escucha de eventos.

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar (unlisten) el evento. Ten en cuenta que eliminar el listener es necesario si tu listener se sale de alcance, por ejemplo, si el componente se desmonta.

Ejemplo

import { listen } from '@tauri-apps/api/event';
const unlisten = await listen<string>('error', (event) => {
  console.log(`Got error, payload: ${event.payload}`);
});

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

Desde

1.0.0

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L115

---

once()

function once<T>(
   event,
   handler,
options?): Promise<UnlistenFn>

Escucha una sola vez un evento emitido para cualquier objetivo (target).

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
event	EventName	Nombre del evento. Debe incluir solo caracteres alfanuméricos, -, /, : y _.
handler	EventCallback<T>	Callback del manejador de eventos.
options?	Opciones	Opciones de escucha de eventos.

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar (unlisten) el evento. Ten en cuenta que eliminar el listener es necesario si tu listener se sale de alcance, por ejemplo, si el componente se desmonta.

Ejemplo

import { once } from '@tauri-apps/api/event';
interface LoadedPayload {
  loggedIn: boolean,
  token: string
}
const unlisten = await once<LoadedPayload>('loaded', (event) => {
  console.log(`App is loaded, loggedIn: ${event.payload.loggedIn}, token: ${event.payload.token}`);
});

// you need to call unlisten if your handler goes out of scope e.g. the component is unmounted
unlisten();

Desde

1.0.0

Origen: https://github.com/tauri-apps/tauri/blob/dev/packages/api/src/event.ts#L159