简介
telejson
是一个可以将 JSON 数据转换成 Telegram Bot 可以发送的格式的 Node.js 模块。它可以使 Telegram Bot 发送美观的消息,而且不需要手动调整消息格式。在现代化的前端开发中,telejson
是非常有用的工具之一。
安装
使用 npm
安装 telejson:
npm install telejson
用法
以下是一个简单的使用示例:
-- -------------------- ---- ------- ----- -------- - -------------------- ----- ---- - --- ---------- ---------- --- -------------- ------------- --------------- ---- --- ----- ------------- - - ----- ------- ------- -- ----- --------------- - ------------------------------ ------------------------------- -----------------
在这个示例中,一个新的 Telejson
实例被创建,并将一个 JSON 字符串转换成一个 Telegram Bot 可以发送的格式的消息。这个消息字符串将通过 telegramBot
发送给指定的 chatId
。这样,你就可以发现,telejson
相对较为简单,就像许多 npm 包一样,只是一个单纯地进行 JSON 转换的模块而已。
参数
telejson
构造函数所接受的参数如下:
参数 | 类型 | 默认值 | 描述 |
---|---|---|---|
tagLength | Number | 10 | 用于切割 JSON 键名的标签长度 |
codeBlockLang | String | 'javascript' | 代码块的语言名称 |
escapeMarkdown | Boolean | false |
是否需要转义 markdown 的字符 |
键名切割
为了保持发送的消息美观,telejson
在默认情况下会将 JSON 键名切割成几段。你可以通过 tagLength
参数来设置每段的长度。例如,如果你将 tagLength
设为 20
,telejson
将把这个字符串 "thisisaverylongtag"
切割成 "thisisaverylongtag"
和 "20"
) 两段。
转义 markdown
如果要发送 Telegram Bot 消息时要包含 markdown 标记,那么 telejson
可能会认为它是普通文本而不是 markdown,因为 telejson
相对较为简单,不会对 markdown 进行特殊处理。在这种情况下,你可以通过将 escapeMarkdown
参数设置为 true
来解决这个问题。
代码块语言
如果要在 Telegram 发送代码块,那么需要为代码块设置语言名称,否则 Telegram 不会正确地高亮代码。为此,可以通过 codeBlockLang
参数来设置代码块的语言名称。
总结
我们介绍了 npm 包 telejson
的用法和相关参数。它可以非常方便口地将 JSON 数据转换成 Telegram Bot 可以发送的格式的消息。telejson
使用起来非常简单,同时具有一定的配置性。希望这篇文章能够给你带来一些帮助!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/telejson