@grammyjs/emoji

中文文档
1.2.0发布于 2023/12/31MITTypeScriptCommonJS零依赖近 30 天下载 1.2万

Use emoji names instead of Unicode strings. Copy-pasting emoji sucks.

原始使用文档
文档目录3 节
  1. Installation
  2. Usage
  3. Contribute

grammY emoji

Adds emoji parsing for grammY. Check out the official documentation to learn more about this plugin.

Installation

Using npm:

npm install @grammyjs/emoji

Using Yarn:

yarn add @grammyjs/emoji

Using Deno:

import {/* ... */} from "https://deno.land/x/grammy_emoji/mod.ts";

Usage

import { Bot, Context } from "grammy";
import { EmojiFlavor, emojiParser } from "@grammyjs/emoji";

type MyContext = EmojiFlavor<Context>;
const bot = new Bot<MyContext>(""); // <-- put your bot token between the ""

bot.use(emojiParser());

bot.command("ping", async (ctx) => {
    // Don't know emoji names? No problem!
    // Press Ctrl + Space on supported editors to
    // see IntelliSense auto-completion magic.
    await ctx.reply(ctx.emoji`Pong! ${"ping_pong"}`);
    // > Pong! 🏓
});

bot.command("start", async (ctx) => {
    await ctx
        .replyWithEmoji`Welcome to my bot! ${"grinning_face_with_big_eyes"}`;
    // > Welcome to my bot! 😀
});

bot.start();

Contribute

Contributions are more than welcome! Just make sure if there is already a similar PR, so you can contribute from there.

版本与发布记录

@grammyjs/emoji 共发布 3 个版本,首次发布于 2022/01/08;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.2.0latest2023/12/312 年前
1.1.02022/04/134 年前
1.0.02022/01/084 年前

关于 @grammyjs/emoji 的常见问题

@grammyjs/emoji 是什么?

Use emoji names instead of Unicode strings. Copy-pasting emoji sucks.

如何安装 @grammyjs/emoji?

在项目目录运行 npm install @grammyjs/emoji,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:grammy(^1.7.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@grammyjs/emoji 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@grammyjs/emoji 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@grammyjs/emoji 可以商用吗?

@grammyjs/emoji 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@grammyjs/emoji 的下载量有多少?

根据 npm 官方下载统计,@grammyjs/emoji 在 2026/10/17 – 2026/11/15 这 30 天内被下载 11,903 次,日均约 397 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@grammyjs/emoji 还在维护吗?

最新版本 1.2.0 发布于 2023/12/31(2 年前);至今共发布 3 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/01/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。