Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/mtkruto/client/4_client.ts>ClientParams

Cross-runtime JavaScript library for building Telegram clients
Go to Latest
interface ClientParams
implements ClientPlainParams
import { type ClientParams } from "https://deno.land/x/mtkruto@0.1.157/client/4_client.ts";

Properties

optional
parseMode: ParseMode

A parse mode to use when the parseMode parameter is not specified when sending or editing messages. Defauls to ParseMode.None.

optional
appVersion: string

The app_version parameter to be passed to initConnection when calling authorize. It is recommended that this parameter is changed if users are authorized. Defaults to "MTKruto" followed by this version of MTKruto.

optional
deviceModel: string

The device_version parameter to be passed to initConnection when calling authorize. The default varies by the current runtime.

optional
langCode: string

The lang_code parameter to be passed to initConnection when calling authorize. Defaults to the runtime's language or "en".

optional
langPack: string

The lang_pack parameter to be passed to initConnection when calling authorize. Defaults to an empty string.

optional
systemLangCode: string

The system_lang_cde parameter to be passed to initConnection when calling authorize. Defaults to the runtime's language or "en".

optional
systemVersion: string

The system_version parameter to be passed to initConnection when calling authorize. The default varies by the current runtime.

optional
autoStart: boolean

Whether to automatically call start with no parameters in the first invoke call. Defaults to true.

optional
defaultHandlers: boolean

Whether to use default handlers. Defaults to true.

optional
ignoreOutgoing: boolean

Whether to ignore outgoing messages. Defaults to true for bots, and false for users.

optional
prefixes: string | string[]

Default command prefixes. Defaults to "/" for bots and "\" for users. This option must be set separately for nested composers.

optional
guaranteeUpdateDelivery: boolean

Whether to guarantee that order-sensitive updates are delivered at least once before delivering next ones. Useful mainly for clients providing a user interface à la Telegram Desktop. Defaults to false.

optional
dropPendingUpdates: boolean

Whether to not handle updates received when the client was not running. Defaults to true for bots, and false for users.

optional
storeMessages: boolean

Whether to store messages. Defaults to false.