@iamnnort/telegraf-helper NPM

Info

Helpers for Telegraf.js framework - Simple - Customizable - Convenient

Installation

NPM

npm install @iamnnort/telegraf-helper

Yarn

yarn add @iamnnort/telegraf-helper

Usage

messageHelper.makeMessage

Make well formatted messages with header and body sections.

Example

import { messageHelper } from "@iamnnort/telegraf-helper";

const message = messageHelper.makeMessage({
  header: [
    {
      title: "Telegraf Helper",
      subtitle: "Make your code smaller",
    },
  ],
  body: ["Simple", "Customizable", "Convenient"],
});

Log

<b>Telegraf Helper</b>: Make your code smaller

Simple
Customizable
Convenient

Parameters

Parameter	Description
`header`	List of configs for the header section
`header[i].title`	Title of the header
`header[i].subtitle`	Additional title of the header
`body`	List of strings of the body section

messageHelper.makeEntityMessage

Make well formatted messages for a given entity.

Example

import { messageHelper } from "@iamnnort/telegraf-helper";

const entityMessage = messageHelper.makeEntityMessage({
  title: "Telegraf Helper",
  comment: "All the Best",
  fallback: "Oops",
  properties: [
    {
      name: "Complexity",
      value: "Simple",
    },
    {
      name: "Flexibility",
      value: "Customizable",
    },
    {
      name: "Usability",
      value: "Convenient",
    },
  ],
});

Log

<b>Telegraf Helper:</b>

— <i>Complexity:</i> Simple
— <i>Flexibility:</i> Customizable
— <i>Usability:</i> Convenient

All the Best

Parameters

Parameter	Description
`title`	Title of the entity block shown at the top
`comment`	Comment of the entity block shown at the bottom
`fallback`	Fallback if properties are empty or missing
`properties`	List of configs for the entity properties
`properties[i].name`	Name of the property
`properties[i].value`	Value of the property

messageHelper.formatMessage

Format message by transforming custom tags to HTML analogs.

Example

import { messageHelper } from "@iamnnort/telegraf-helper";

const formattedMessage = messageHelper.formatMessage("[b]Telegraf Helper[b]");

// <b>Telegraf Helper</b>

Transform map

Parameter	Description
`[b]Example[b]`	`<b>Example</b>`
`[i]Example[i]`	`<i>Example</i>`
`[u]Example[u]`	`<u>Example</u>`
`[t]Example[t]`	`<s>Example</b>`
`[s]Example[s]`	`<tg-spoiler>Example</tg-spoiler>`
`[c]Example[c]`	`<code>Example</code>`
`[a]Example=https://example.com[a]`	`<a href="https://example.com">Example</a>`

telegramHelper.getBotId

Retrieve the identifier for a given token.

Example

import { telegramHelper } from "@iamnnort/telegraf-helper";

const botId = telegramHelper.getBotId("<bot token>");

// 6607146717

telegramHelper.makeInlineLink

Make the inline link for a given username.

Example

import { telegramHelper } from "@iamnnort/telegraf-helper";

const inlineLink = telegramHelper.makeInlineLink("iamnnort");

// @iamnnort

telegramHelper.makeLink

Make the external link for a given username.

Example

import { telegramHelper } from "@iamnnort/telegraf-helper";

const link = telegramHelper.makeLink("iamnnort");

// https://t.me/iamnnort

Make Telegram instance from Telegraf with additional useful functions like sendSmart.

Example

import { Telegram } from "@iamnnort/telegraf-helper";

const telegram = new Telegram("<bot token>");

await telegram.sendSmart(TelegramMessageTypes.TEXT, "iamnnort", {
  text: "<text>",
});

await telegram.sendSmart(TelegramMessageTypes.PHOTO, "iamnnort", {
  text: "<text>",
  media: "<photo ID or URL>",
});