Class BrowserEventDispatcher<T>

A concrete implementation of EventDispatcher that dispatches events to the browser window.

Type Parameters

T extends { type: string }

Implements

EventDispatcher<T>

Index

Constructors

Methods

addEventListener dispatchEvent

Constructors

constructor

new BrowserEventDispatcher<T extends { type: string }>(): BrowserEventDispatcher<
T,
>
Type Parameters
- T extends { type: string }
Returns BrowserEventDispatcher<T>

Methods

addEventListener

addEventListener<P extends `ton-connect-${string}` | `ton-connect-ui-${string}`>(
    eventName: P,
    listener: (
        event: CustomEvent<T & { type: RemoveTonConnectPrefix<P> }>,
    ) => void,
    options?: AddEventListenerOptions,
): Promise<() => void>
Adds an event listener to the browser window.
Type Parameters
- P extends `ton-connect-${string}` | `ton-connect-ui-${string}`
Parameters
- eventName: P
  The name of the event to listen for.
- listener: (event: CustomEvent<T & { type: RemoveTonConnectPrefix<P> }>) => void
  The listener to add.
- Optionaloptions: AddEventListenerOptions
  The options for the listener.
Returns Promise<() => void>
A function that removes the listener.
Implementation of EventDispatcher.addEventListener
- Defined in packages/sdk/lib/types/index.d.ts:63

dispatchEvent

dispatchEvent<P extends `ton-connect-${string}` | `ton-connect-ui-${string}`>(
eventName: P,
eventDetails: T & { type: RemoveTonConnectPrefix<P> },
): Promise<void>
Dispatches an event with the given name and details to the browser window.
Type Parameters
- P extends `ton-connect-${string}` | `ton-connect-ui-${string}`
Parameters
- eventName: P
  The name of the event to dispatch.
- eventDetails: T & { type: RemoveTonConnectPrefix<P> }
  The details of the event to dispatch.
Returns Promise<void>
A promise that resolves when the event has been dispatched.
Implementation of EventDispatcher.dispatchEvent
- Defined in packages/sdk/lib/types/index.d.ts:53