Client

class

extends TypedEmitter<ClientEvents>

The main entry point of the library. Wraps the transport, emits typed events for incoming updates, and exposes the full Bot API via .

Declaration

declare class Client extends TypedEmitter<ClientEvents>

apiproperty#

readonly api: ApiMethods;

Fully-typed access to every Bot API method.

get isReady(): boolean;

Whether the client has completed login.

readonly polling: PollingClient;

readyAt: Date | null;

When the client became ready.

restproperty#

readonly rest: REST;

tokenproperty#

get token(): string | null;

uptimeproperty#

get uptime(): number | null;

Milliseconds since the client became ready, or null if not ready.

userproperty#

user: ClientUser | null;

The bot's own account. null until resolves.

readonly webhook: WebhookClient;

constructor(options?: ClientOptions);

Constructs a new instance of the Client class

login(token?: string | null): Promise<ClientUser>;

Parameter	Type
token?	string \| null

Returns Promise<ClientUser>

Authenticate the bot, fetch its own account via getMe, and emit ready. Does not start receiving updates — call or set up a webhook for that.

startPolling(options?: PollingOptions): Promise<ClientUser>;

Parameter	Type
options?	PollingOptions

Returns Promise<ClientUser>

stopPolling(): void;

Returns void

Stop long polling, if running.