npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tg-format

v1.1.2

Published

A tiny Node.JS helper for sending formatted text messages using Telegram Bot API

Downloads

11

Readme

tg-format

Боты для Telegram, использующие Telegram Bot API, могут использовать различные методы для отправки и редактирования сообщений – sendMessage, sendPhoto, editMessageText и пр. Все эти методы поддерживают форматирование текста при помощи HTML разметки (используя параметр parse_mode), либо вручную сформированным массивом размеченных сущностей entities (или caption_entities). Эта библиотека упрощает использование обоих способов разметки.

Установка

npm install tg-format

Форматирование при помощи HTML

Самый простой способ разметки — при помощи HTML-тегов. Однако при подстановке пользовательских данных в тело сообщения в них необходимо экранировать символы '<', '>' и '&'. Для этого доступна функция html, которую предполагается использовать в tagged template literals:

const { html } = require('tg-format');

// Предполагается, что функция sendMessage вызывает соответствующий метод Telegram Bot API
sendMessage({
  // ... chat_id, reply_markup и т.д.
  text: html`Имя пользователя: <b>${user.firstName}</b> ${user.lastName}`,
  parse_mode: 'HTML',
})

Она экранирует символы '<', '>' и '&' для всех подставляемых значений (заменяя их на '&lt;', '&gt;' и '&amp;' соответственно):

const hackyName = 'foo</b> bar'; // Пользовательские данные; например, имя или введённое сообщение
console.log(`Name: <b>${hackyName}</b>`); // Выведет 'Name: <b>foo</b> bar</b>' — некорректная разметка
console.log(html`Name: <b>${hackyName}</b>`); // Выведет 'Name: <b>foo&lt;/b&gt; bar</b>' — правильно экранированное значение

Экранирование текста для разметки с помощью Markdown не поддерживается, так как следует более сложным (и контекстно-зависимым) правилам.

Форматирование при помощи массива entities

Более продвинутый способ создания форматированного текста — с помощью массива сущностей (который передаётся в параметре entities или caption_entities). Для этого используйте функцию fmt:

const { fmt } = require('tg-format');

// Предполагается, что функция sendMessage вызывает соответствующий метод Telegram Bot API
const formatted = fmt`Имя пользователя: ${[user.firstName, 'bold']} ${user.lastName}`;
sendMessage({
  // ... chat_id, reply_markup и т.д.
  text: formatted.text,
  entities: formatted.entities,
})

Чтобы разметить подставляемое значение, используйте массив из двух (или более) элементов: само значение и тип сущности ('bold' в примере выше для выделения текста жирным). Тип сущности можно передавать строкой либо объектом (например { type: 'text_link', url: 'https://telegram.org' }). Если передать больше двух элементов, будет создано несколько сущностей: например ${[user.firstName, 'bold', 'italic']} выведет имя полужирным курсивом.

Функция fmt возвращает экземпляр класса FormattedString, содержащий два поля: text и entities. Так как метод sendMessage ожидает именно такие параметры, код выше можно записать лаконичнее при помощи оператора деструктуризации:

sendMessage({
  // ... chat_id, reply_markup и т.д.
  ...fmt`Имя пользователя: ${[user.firstName, 'bold']} ${user.lastName}`,
})

В случае с методами, ожидающими другие параметры (например, caption и caption_entities для sendPhoto), можно использовать метод toObject:

sendPhoto({
  // ... chat_id, reply_markup и т.д.
  ...fmt`Имя пользователя: ${[user.firstName, 'bold']} ${user.lastName}`.toObject('caption', 'caption_entities'),
})

Класс FormattedString реализует многие методы класса String. В данный момент только методы substring и slice возвращают новые экземпляры FormattedString.

В особенности может быть полезен метод concat, позволяющий конкатенировать с текущим объектом другие строки или экземпляры FormattedString. Это немутирующий метод, создающий новый экземпляр FormattedString. У него есть также мутирующий аналог append (который изменяет текущий экземпляр). Незначительное отличие от метода concat строк заключается в том, что массивы (любой вложенности), передаваемые как параметры, будут «распакованы» и их элементы будут конкатенированы без разделителей. Кроме того, непосредственно в конструктор FormattedString может быть передано любое число параметров, которые будут аналогичным образом конкатенированы вместе.

Также доступен статический метод FormattedString.join(strings, separator), аналогичный методу join у массивов, склеивающий элементы массива, используя указанный разделитель.

Объекты FormattedString (или их массивы) можно использовать при подстановке в другие вызовы fmt:

const formatted = fmt`Участники:\n\n${
  FormattedString.join(users.map(user => fmt`${[
    fmt`${[user.firstName, 'bold']} ${user.lastName}`,
    { type: 'text_link', url: user.website }
  ]}`), '\n')
}`;