Interface BaseTelegramClientOptions

interface BaseTelegramClientOptions {
    apiHash: string;
    apiId: number;
    crypto?: ICryptoProvider;
    defaultDcs?: DcOptions;
    disableUpdates?: boolean;
    enableErrorReporting?: boolean;
    initConnectionOptions?: Partial<
        Omit<RawInitConnectionRequest, "query" | "apiId">,
    >;
    logger?: Logger;
    logLevel?: number;
    network?: NetworkManagerExtraParams;
    overrideLayer?: number;
    platform?: ICorePlatform;
    readerMap?: TlReaderMap;
    reconnectionStrategy?: ReconnectionStrategy;
    storage?: string | ITelegramStorageProvider;
    storageOptions?: StorageManagerExtraOptions & TelegramStorageManagerExtraOptions;
    testMode?: boolean;
    transport?: TelegramTransport;
    updates?: false | UpdatesManagerParams;
    useIpv6?: boolean;
    writerMap?: TlWriterMap;
}

Hierarchy (View Summary)

Properties

apiHash apiId crypto? defaultDcs? disableUpdates? enableErrorReporting? initConnectionOptions? logger? logLevel? network? overrideLayer? platform? readerMap? reconnectionStrategy? storage? storageOptions? testMode? transport? updates? useIpv6? writerMap?

Properties

apiHash

apiHash: string

API hash from my.telegram.org

apiId

apiId: number

API ID from my.telegram.org

Optionalcrypto

crypto?: ICryptoProvider

Cryptography provider to allow delegating crypto to native addon, worker, etc.

OptionaldefaultDcs

defaultDcs?: DcOptions

Primary DC to use for initial connection. This does not mean this will be the only DC used, nor that this DC will actually be primary, this only determines the first DC the library will try to connect to. Can be used to connect to other networks (like test DCs).

When session already contains primary DC, this parameter is ignored.

Default

Production DC 2.

OptionaldisableUpdates

disableUpdates?: boolean

If true, all API calls will be wrapped with tl.invokeWithoutUpdates, effectively disabling the server-sent events for the clients. May be useful in some cases.

Default

false

OptionalenableErrorReporting

enableErrorReporting?: boolean

mtcute can send all unknown RPC errors to danog's error reporting service.

This is fully anonymous (except maybe IP) and is only used to improve the library and developer experience for everyone working with MTProto. This is fully opt-in, and if you're too paranoid, you can disable it by manually passing enableErrorReporting: false to the client.

Default

false

OptionalinitConnectionOptions

initConnectionOptions?: Partial<
    Omit<RawInitConnectionRequest, "query" | "apiId">,
>

Additional options for initConnection call. apiId and query are not available and will be ignored. Omitted values will be filled with defaults

Optionallogger

logger?: Logger

Logger instance for the client. If not passed, a new one will be created.

OptionallogLevel

logLevel?: number

Set logging level for the client. Shorthand for client.log.level = level.

See static members of LogManager for possible values.

Optionalnetwork

network?: NetworkManagerExtraParams

Extra parameters for NetworkManager

OptionaloverrideLayer

overrideLayer?: number

EXPERT USE ONLY!

Override TL layer used for the connection.

Does not change the schema used.

Optionalplatform

platform?: ICorePlatform

OptionalreaderMap

readerMap?: TlReaderMap

EXPERT USE ONLY

Override reader map used for the connection.

OptionalreconnectionStrategy

reconnectionStrategy?: ReconnectionStrategy

Reconnection strategy.

Default

simple reconnection strategy: first 0ms, then up to 5s (increasing by 1s)

Optionalstorage

storage?: string | ITelegramStorageProvider

Storage to use for this client.

If a string is passed, it will be used as a name for an SQLite database file.

Default

"client.session"

OptionalstorageOptions

storageOptions?: StorageManagerExtraOptions & TelegramStorageManagerExtraOptions

Additional options for the storage manager

OptionaltestMode

testMode?: boolean

Whether to connect to test servers.

If passed, defaultDc defaults to Test DC 2.

Must be passed if using test servers, even if you passed custom defaultDc

Optionaltransport

transport?: TelegramTransport

Transport to use in the client.

Default

platform-specific transport: WebSocket on the web, TCP in node

Optionalupdates

updates?: false | UpdatesManagerParams

OptionaluseIpv6

useIpv6?: boolean

Whether to use IPv6 datacenters (IPv6 will be preferred when choosing a DC by id) (default: false)

OptionalwriterMap

writerMap?: TlWriterMap

EXPERT USE ONLY

Override writer map used for the connection.

Settings

Member Visibility

On This Page

Properties