Interface EventDispatcher<T>

Interface for an event dispatcher that sends events.

Type Parameters

T extends {
type: string;
}

Hierarchy

EventDispatcher

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.

Returns
A function that removes the 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.
 - - (event: CustomEvent<T & {
 type: RemoveTonConnectPrefix;
 }>): void
 - Parameters
 
 event: CustomEvent<T & {
 type: RemoveTonConnectPrefix;
 }>
 
 Returns void
- Optional options: AddEventListenerOptions
 
 The options for the listener.
Returns Promise<(() => void)>
- Defined in packages/sdk/src/tracker/event-dispatcher.ts:33

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/src/tracker/event-dispatcher.ts:21

Interface EventDispatcher<T>

Type Parameters

T extends {
type: string;
}

Hierarchy

Implemented by

Index

Methods

Methods

addEventListener

Returns

Type Parameters

P extends `ton-connect-${string}` | `ton-connect-ui-${string}`

Parameters

eventName: P

listener: ((event: CustomEvent<T & {
type: RemoveTonConnectPrefix<P>;
}>) => void)

Parameters

event: CustomEvent<T & {
type: RemoveTonConnectPrefix<P>;
}>

Returns void

`Optional` options: AddEventListenerOptions

Returns Promise<(() => void)>

dispatchEvent

Type Parameters

P extends `ton-connect-${string}` | `ton-connect-ui-${string}`

Parameters

eventName: P

eventDetails: T & {
type: RemoveTonConnectPrefix<P>;
}

Returns Promise<void>

Settings

Member Visibility

Theme

Interface EventDispatcher<T>

Type Parameters

T extends { type: string; }

Hierarchy

Implemented by

Index

Methods

Methods

addEventListener

Returns

Type Parameters

P extends `ton-connect-${string}` | `ton-connect-ui-${string}`

Parameters

eventName: P

listener: ((event: CustomEvent<T & { type: RemoveTonConnectPrefix<P>; }>) => void)

Parameters

event: CustomEvent<T & { type: RemoveTonConnectPrefix<P>; }>

Returns void

Optional options: AddEventListenerOptions

Returns Promise<(() => void)>

dispatchEvent

Type Parameters

P extends `ton-connect-${string}` | `ton-connect-ui-${string}`

Parameters

eventName: P

eventDetails: T & { type: RemoveTonConnectPrefix<P>; }

Returns Promise<void>

Settings

Member Visibility

Theme

T extends {
type: string;
}

listener: ((event: CustomEvent<T & {
type: RemoveTonConnectPrefix<P>;
}>) => void)

event: CustomEvent<T & {
type: RemoveTonConnectPrefix<P>;
}>

`Optional` options: AddEventListenerOptions

eventDetails: T & {
type: RemoveTonConnectPrefix<P>;
}