Documentation
    Preparing search index...

    Interface TonConnectOptions

    TonConnect constructor options

    interface TonConnectOptions {
        disableAutoPauseConnection?: boolean;
        eventDispatcher?: EventDispatcher<SdkActionEvent>;
        manifestUrl?: string;
        storage?: IStorage;
        walletsListCacheTTLMs?: number;
        walletsListSource?: string;
        walletsRequiredFeatures?: RequiredFeatures;
    }
    Index

    Properties

    disableAutoPauseConnection? eventDispatcher? manifestUrl? storage? walletsListCacheTTLMs? walletsListSource? walletsRequiredFeatures?

    Properties

    disableAutoPauseConnection?: boolean

    Allows to disable auto pause/unpause SSE connection on 'document.visibilitychange' event. It is not recommended to change default behaviour.

    eventDispatcher?: EventDispatcher<SdkActionEvent>

    Event dispatcher to track user actions. By default, it uses window.dispatchEvent for browser environment.

    manifestUrl?: string

    Url to the [manifest]https://github.com/ton-connect/docs/blob/main/requests-responses.md#app-manifest with the Dapp metadata that will be displayed in the user's wallet. If not passed, manifest from ${window.location.origin}/tonconnect-manifest.json will be taken.

    storage?: IStorage

    Storage to save protocol data. For browser default is localStorage. If you use SDK with nodeJS, you have to specify this field.

    walletsListCacheTTLMs?: number

    Wallets list cache time to live

    Infinity
    walletsListSource?: string

    Redefine wallets list source URL. Must be a link to a json file with [following structure]https://github.com/ton-connect/wallets-list

    https://raw.githubusercontent.com/ton-connect/wallets-list/main/wallets.json
    @
    walletsRequiredFeatures?: RequiredFeatures

    Required features for wallets. If wallet doesn't support required features, it will be disabled.

    Settings

    Member Visibility

    On This Page

    Properties