@flasd/whatsapp-formatting

中文文档
0.2.0发布于 2025/08/29MITESM + CJS零依赖近 30 天下载 8638

WhatsApp 允许您在信件中格式化选中的文本 .

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. 支持的格式
  4. MIT 许可证

网络应用格式

Build Status Coverage Status npm version npm downloads per month

如果你可以使用一个惊人的文本格式 语法, 数百万人已经习惯在您的应用程序中? 单单 你可以的 提示什么应用格式 您可以使用 *bold *, italic , ~striptroption~, * monospace *, 或 “内置代码 ” 。 (只有510字节gzip!)

安装

$ yarn add @flasd/whatsapp-formatting

// or if you are feeling old school
$ npm install @flasd/whatsapp-formatting

使用量

API非常简单.

import { format } from "@flasd/whatsapp-formatting";

format("*hello* _world_");
// « '<strong>hello</strong> <i>world</i>'

format("~how are you?~");
// « '<s>how are you?</s>'

format("```monospace text```");
// « '<code>monospace text</code>'

format("`inline code`");
// « '<code>inline code</code>'

format(`
multiline
string
`);
// « '<br>multiline<br>string<br>'

支持的格式

此库支持以下WhatsApp文本格式:

  • 粗体数字 : *text* → <strong>text</strong>
  • 斜体数字 : _text_ → <i>text</i>
  • 切换数字 : ~text~ → <s>text</s>
  • 单相空间数字 : ```text``` → <code>text</code>
  • 内置代码数字 : `text` → <code>text</code>
  • 换行符数字 : \n → <br>

您可以混合和匹配所有格式化 。 瓳 如果您想要, 您可以自定义格式规则 :

import { format, whatsappRules } from "@flasd/whatsapp-formatting";

const customRules = [
  ...whatsappRules,
  {
    wildcard: "|",
    openTag: '<span style="font-family:monospace">',
    closeTag: "</span>",
  },
];

format("|some awesome code|", customRules);
// « '<span style="font-family:monospace">some awesome code</span>'

MIT 许可证

版权所有:2020年 MIT 许可证。 。 。 . 去疯狂。 摇滚:

版本与发布记录

@flasd/whatsapp-formatting 共发布 6 个版本,首次发布于 2020/01/15;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.2.0latest2025/08/291.2 年前
0.1.42020/11/116 年前
0.1.32020/11/116 年前
0.1.22020/11/106 年前
0.1.12020/01/156 年前
0.1.02020/01/156 年前

关于 @flasd/whatsapp-formatting 的常见问题

@flasd/whatsapp-formatting 是什么?

WhatsApp 允许您在信件中格式化选中的文本 .

如何安装 @flasd/whatsapp-formatting?

在项目目录运行 npm install @flasd/whatsapp-formatting,或使用 pnpm add / yarn add / bun add。

@flasd/whatsapp-formatting 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/flasd__whatsapp-formatting 是否存在。

@flasd/whatsapp-formatting 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@flasd/whatsapp-formatting 可以商用吗?

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

@flasd/whatsapp-formatting 的下载量有多少?

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

@flasd/whatsapp-formatting 还在维护吗?

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