# @flasd/whatsapp-formatting 中文文档

规范地址：https://npmcn.com/package/%40flasd/whatsapp-formatting/

版本：0\.2\.0
npm 元数据更新时间：2025-08-29T12:30:30.933Z
中文译文更新时间：2026-11-14T21:34:52.145Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40flasd/whatsapp-formatting
原文对照：https://npmcn.com/package/%40flasd/whatsapp-formatting/?lang=original
项目主页：https://github.com/flasd/whatsapp-formatting#readme
源码仓库：https://github.com/flasd/whatsapp-formatting

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：17.1 kB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2020-01-15T01:47:05.900Z
- 最新版本发布：2025-08-29T12:30:30.715Z
- 近 30 天下载量：8638（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

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

## 安装

```sh
npm install @flasd/whatsapp-formatting
```

也可以使用：`pnpm add @flasd/whatsapp-formatting`、`yarn add @flasd/whatsapp-formatting`、`bun add @flasd/whatsapp-formatting`

## README

# 网络应用格式

[![Build Status](https://travis-ci.org/flasd/whatsapp-formatting.svg?branch=master)](https://travis-ci.org/flasd/whatsapp-formatting) [![Coverage Status](https://coveralls.io/repos/github/flasd/whatsapp-formatting/badge.svg?branch=master)](https://coveralls.io/github/flasd/whatsapp-formatting?branch=master) [![npm version](https://badge.fury.io/js/@flasd/whatsapp-formatting.svg)](https://www.npmjs.com/package/@flasd/whatsapp-formatting) [![npm downloads per month](https://img.shields.io/npm/dm/@flasd/whatsapp-formatting.svg)](https://www.npmjs.com/package/@flasd/whatsapp-formatting)

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

## 安装

```shell
$ yarn add @flasd/whatsapp-formatting

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

## 使用量

API非常简单.

```javascript
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>`

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

```javascript
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 许可证](https://github.com/flasd/whatsapp-formatting/blob/master/LICENSE)。 。 。 . 去疯狂。 摇滚:

## 常见问题

### @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 和提交记录判断。