Class NodeApiClient

Abstract core describing the transport layer.

Hierarchy (View Summary)

BaseTelegramClient
- NodeApiClient

Index

Constructors

Properties

Accessors

Methods

callApi consumeWebhookReply enableWebhookReply

Constructors

constructor

new NodeApiClient(token: string): NodeApiClient
Creates a new client instance.
Parameters
- token: string
  Your bot's token
Returns NodeApiClient
Inherited from BaseTelegramClient.constructor
- Defined in core/base-api.ts:32

Properties

`Protected` `Readonly`baseUrl

baseUrl: string

Accessors

raw

get raw(): TelegramBotApi
Proxy that "pretends" to be a full TelegramBotApi implementation.

Returns TelegramBotApi
TelegramBotApi
Inherited from BaseTelegramClient.raw
- Defined in core/base-api.ts:48

Methods

callApi

callApi<T>(method: string, payload?: Record<string, unknown>): Promise<T>
Request method implemented by each platform.
Type Parameters
- T
Parameters
- method: string
  Method name
- payload: Record<string, unknown> = {}
  Parameters object
Returns Promise<T>
Promise<T>
Overrides BaseTelegramClient.callApi
- Defined in adapters/node.ts:65

consumeWebhookReply

consumeWebhookReply(): WebhookReplyPayload | null
Retrieve and clear the captured webhook reply payload. Returns null if no payload was captured (e.g., the first call had files, or no API calls were made during this update).

Returns WebhookReplyPayload | null
- Defined in adapters/node.ts:58

enableWebhookReply

enableWebhookReply(): void
Enable webhook reply mode. Call this BEFORE handleUpdate() to capture the first text-only API call as a JSON payload instead of sending it via fetch.

⚠️ Important trade-off: When a call is captured, the corresponding ctx.reply() / ctx.api.* method returns an empty object {} instead of the real Telegram response. This means you cannot rely on the return value (e.g., msg.message_id will be undefined).

Use this only when you don't need the return value of the first API call.

Returns void
Example
```
app.post('/webhook', async (req, res) => {
  client.enableWebhookReply();
  await bot.handleUpdate(req.body);

  const reply = client.consumeWebhookReply();
  if (reply) {
    res.json(reply);
  } else {
    res.json({ ok: true });
  }
});
```
- Defined in adapters/node.ts:48