Interface EventDispatcher<T>

Interface for an event dispatcher that sends events.

interface EventDispatcher<T extends { type: string }> {
 addEventListener(
 eventName: P,
 listener: (
 event: CustomEvent<T & { type: RemoveTonConnectPrefix }>,
 ) => void,
 options?: AddEventListenerOptions,
 ): Promise<() => void>;
 dispatchEvent(
 eventName: P,
 eventDetails: T & { type: RemoveTonConnectPrefix },
 ): Promise<void>;
}

Type Parameters

T extends { type: string }

Implemented by

BrowserEventDispatcher

Index

Methods

addEventListener dispatchEvent

Methods

addEventListener

addEventListener(
 eventName: P,
 listener: (
 event: CustomEvent<T & { type: RemoveTonConnectPrefix }>,
 ) => void,
 options?: AddEventListenerOptions,
): Promise<() => void>
Adds an event listener.
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 }>) => void
 The listener to add.
- Optionaloptions: AddEventListenerOptions
 The options for the listener.
Returns Promise<() => void>
A function that removes the listener.
- Defined in packages/sdk/lib/types/index.d.ts:451

dispatchEvent

dispatchEvent(
eventName: P,
eventDetails: T & { type: RemoveTonConnectPrefix },
): Promise<void>
Dispatches an event with the given name and details.
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 }
 The details of the event to dispatch.
Returns Promise<void>
- Defined in packages/sdk/lib/types/index.d.ts:441

Interface EventDispatcher<T>

Type Parameters

Implemented by

Index

Methods

Methods

addEventListener

Type Parameters

Parameters

Returns Promise<() => void>

dispatchEvent

Type Parameters

Parameters

Returns Promise<void>

Settings

On This Page