Interface IEventServer

interface IEventServer {
    emit: (event: string, payload?: unknown) => Promise<void>;
    emitTo: (
        target: string | EventTarget,
        event: string,
        payload?: unknown,
    ) => Promise<void>;
    rawUnlisten: (event: string, eventId: number) => Promise<void>;
    once<T>(
        event: EventName,
        handler: EventCallback<any>,
        options?: Options,
    ): Promise<UnlistenFn>;
    rawListen<T>(
        event: EventName,
        target: EventTarget,
        handler: EventCallback<any>,
    ): Promise<number>;
}

Properties

emit emitTo rawUnlisten

Methods

once rawListen

Properties

emit

emit: (event: string, payload?: unknown) => Promise<void>

Type declaration

    • (event: string, payload?: unknown): Promise<void>

    • Emits an event to all EventTarget|targets.

      Parameters

      • event: string

        Event name. Must include only alphanumeric characters, -, /, : and _.

      • Optionalpayload: unknown

        Event payload.

      Returns Promise<void>

      Example

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

      Since

      1.0.0

emitTo

emitTo: (
    target: string | EventTarget,
    event: string,
    payload?: unknown,
) => Promise<void>

Type declaration

    • (target: string | EventTarget, event: string, payload?: unknown): Promise<void>

    • Emits an event to all EventTarget|targets matching the given target.

      Parameters

      • target: string | EventTarget

        Label of the target Window/Webview/WebviewWindow or raw EventTarget object.

      • event: string

        Event name. Must include only alphanumeric characters, -, /, : and _.

      • Optionalpayload: unknown

        Event payload.

      Returns Promise<void>

      Example

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

      Since

      2.0.0

rawUnlisten

rawUnlisten: (event: string, eventId: number) => Promise<void>

Methods

once

  • once<T>(
        event: EventName,
        handler: EventCallback<any>,
        options?: Options,
    ): Promise<UnlistenFn>

  • Type Parameters

    • T

    Parameters

    • event: EventName
    • handler: EventCallback<any>
    • Optionaloptions: Options

    Returns Promise<UnlistenFn>

rawListen

  • rawListen<T>(
        event: EventName,
        target: EventTarget,
        handler: EventCallback<any>,
    ): Promise<number>

  • Type Parameters

    • T

    Parameters

    • event: EventName
    • target: EventTarget
    • handler: EventCallback<any>

    Returns Promise<number>

Settings

Member Visibility

On This Page

Properties
Methods