Class MtClient

constructor

• new MtClient(
      params: MtClientOptions & { onError: (err: unknown) => void },
  ): MtClient

• Parameters

  • params: MtClientOptions & { onError: (err: unknown) => void }

  Returns MtClient

Readonly_config

_defaultDcs

Readonly_layer

Readonly_readerMap

Readonly_writerMap

Readonlycrypto

Readonlylog

Readonlynetwork

ReadonlyonConnecting

ReadonlyonNetworkChanged

ReadonlyonUpdate

ReadonlyonUsable

Readonlyparams

ReadonlystopSignal

Readonlystorage

call

• call<T extends RpcMethod>(
      message: MustEqual<T, RpcMethod>,
      params?: RpcCallOptions,
  ): Promise<RawMt_rpc_error | RpcCallReturn[T["_"]]>

• Make an RPC call.

  The connection must have been connect-ed before calling this method.

  This method is still quite low-level and you shouldn't use this when using high-level API provided by @mtcute/client.

  Type Parameters

  • T extends RpcMethod

  Parameters

  • message: MustEqual<T, RpcMethod>

    RPC method to call
  • Optionalparams: RpcCallOptions

    Additional call parameters

  Returns Promise<RawMt_rpc_error | RpcCallReturn[T["_"]]>

connect

• connect(): Promise<void>

• Initialize the connection to the primary DC.

  You shouldn't usually call this method directly as it is called implicitly the first time you call call.

  Returns Promise<void>

destroy

• destroy(): Promise<void>

• Close all connections and finalize the client.

  Note: must be called after disconnect

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

• Returns Promise<void>

prepare

• prepare(): Promise<void>

• ADVANCED

  Do all the preparations, but don't connect just yet. Useful when you want to do some preparations before connecting, like setting up session.

  Call connect to actually connect.

  Returns Promise<void>