Package-level declarations

Types

Link copied to clipboard
external interface Event<T>
Link copied to clipboard
typealias EventCallback<T> = (event: Event<T>) -> Unit
Link copied to clipboard
typealias EventName = Any
Link copied to clipboard
typealias EventTarget = Any
Link copied to clipboard
external object global
Link copied to clipboard
external interface Options
Link copied to clipboard
sealed external interface TauriEvent
Link copied to clipboard
typealias UnlistenFn = () -> Unit

Functions

Link copied to clipboard
external fun <T> emit(event: String, payload: T = definedExternally): Promise<Void>

Emits an event to all {@link EventTarget|targets}.

Link copied to clipboard
external fun <T> emitTo(target: EventTarget, event: String, payload: T = definedExternally): Promise<Void>
external fun <T> emitTo(target: String, event: String, payload: T = definedExternally): Promise<Void>

Emits an event to all {@link EventTarget|targets} matching the given target.

Link copied to clipboard
external fun <T> listen(event: EventName, handler: EventCallback<T>, options: Options = definedExternally): Promise<UnlistenFn>

Listen to an emitted event to any {@link EventTarget|target}.

Link copied to clipboard
external fun <T> once(event: EventName, handler: EventCallback<T>, options: Options = definedExternally): Promise<UnlistenFn>

Listens once to an emitted event to any {@link EventTarget|target}.