Class TelegramBaseClient<S>Abstract

connected

• get connected(): boolean | undefined

  Returns boolean | undefined

disconnected

• get disconnected(): boolean

  Returns boolean

entityCache

• get entityCache(): EntityCache

  The in-memory entity cache. Exposes size, has, delete and clear so stale peers can be invalidated without touching internals. See TelegramClientParams.entityCache for bounding it.

  Returns EntityCache

floodSleepThreshold

• get floodSleepThreshold(): number

  Returns number

• set floodSleepThreshold(value: number): void

  Parameters

  • value: number

  Returns void

logger

• get logger(): Logger

  Returns Logger

maxConcurrentDownloads

• set maxConcurrentDownloads(value: number): void

  Parameters

  • value: number

  Returns void

onError

• set onError(handler: (error: Error) => Promise<void>): void

  Custom error handler for the client

  Parameters

  • handler: (error: Error) => Promise<void>

  Returns void

  Example

  client.onError = async (error)=>{
          console.log("error is",error)
      }
  Copy

constructor

• new TelegramBaseClient<S extends Session = Session>(
      session: string | S,
      apiId: number,
      apiHash: string,
      clientParams: TelegramClientParams,
  ): TelegramBaseClient<S>

  Type Parameters

  • S extends Session = Session

  Parameters

  • session: string | S
  • apiId: number
  • apiHash: string
  • clientParams: TelegramClientParams

  Returns TelegramBaseClient<S>

_connectSender

• _connectSender(
      sender: MTProtoSender,
      dcId: number,
      connection?: Connection,
      mediaCluster?: boolean,
  ): Promise<MTProtoSender>

  Parameters

  • sender: MTProtoSender
  • dcId: number
  • Optionalconnection: Connection
  • mediaCluster: boolean = false

  Returns Promise<MTProtoSender>

_disconnect

• _disconnect(): Promise<void>

  Returns Promise<void>

_initSession

• _initSession(): Promise<void>

  Returns Promise<void>

_leaseSender

• _leaseSender(dcId: number): Promise<SessionLease>

  Parameters

  • dcId: number

  Returns Promise<SessionLease>

destroy

• destroy(): Promise<void>

  Disconnects all senders and removes all handlers Disconnect is safer as it will not remove your event handlers

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

getDC

• getDC(
      dcId: number,
      download: boolean,
  ): Promise<{ id: number; ipAddress: string; port: number }>

  Parameters

  • dcId: number
  • download: boolean

  Returns Promise<{ id: number; ipAddress: string; port: number }>

getSender

• getSender(dcId: number): Promise<MTProtoSender>

  Parameters

  • dcId: number

  Returns Promise<MTProtoSender>

invoke

• invoke<R extends AnyRequest>(request: R): Promise<R["__response"]>

  Type Parameters

  • R extends AnyRequest

  Parameters

  • request: R

  Returns Promise<R["__response"]>

onConnect

• onConnect(handler: LifecycleHandler): () => void

  Runs when the main transport connects; account sign-in may still be required.

  Parameters

  • handler: LifecycleHandler

  Returns () => void

onConnecting

• onConnecting(handler: LifecycleHandler): () => void

  Runs when the main sender starts connecting, including reconnections.

  Parameters

  • handler: LifecycleHandler

  Returns () => void

onDestroy

• onDestroy(handler: LifecycleHandler): () => void

  Runs once after client resources and subscriptions have been released.

  Parameters

  • handler: LifecycleHandler

  Returns () => void

onDisconnect

• onDisconnect(handler: LifecycleHandler): () => void

  Runs when the main transport disconnects, manually or during recovery.

  Parameters

  • handler: LifecycleHandler

  Returns () => void

onReconnect

• onReconnect(handler: LifecycleHandler): () => void

  Runs after automatic reconnection, the client probe and a catch-up attempt; does not await application handlers.

  Parameters

  • handler: LifecycleHandler

  Returns () => void

onReconnecting

• onReconnecting(handler: LifecycleHandler): () => void

  Runs once when an automatic reconnect cycle starts.

  Parameters

  • handler: LifecycleHandler

  Returns () => void

setLogLevel

• setLogLevel(level: LogLevel): void

  Parameters

  • level: LogLevel

  Returns void

__version__

_connectedDeferred

Optional_lastRequest

apiHash

apiId

networkSocket

session

updateManager