# @amoutonbrady/lz-string 中文文档

规范地址：https://npmcn.com/package/%40amoutonbrady/lz-string/

版本：0\.2\.0
npm 元数据更新时间：2026-09-06T16:01:15.478Z
中文译文更新时间：2026-11-06T01:06:07.270Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：20.2 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2021-01-25T22:10:45.619Z
- 最新版本发布：2026-09-06T16:01:15.325Z
- 近 30 天下载量：13134（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 1 个）

## 中文简介

Lz- string 的现代类型脚本端口:基于 LZ 的 JavaScript 字符串压缩

## 安装

```sh
npm install @amoutonbrady/lz-string
```

也可以使用：`pnpm add @amoutonbrady/lz-string`、`yarn add @amoutonbrady/lz-string`、`bun add @amoutonbrady/lz-string`

## README

# @amoutonbrady/lz-string (英语)

现代类型脚本端口 [长弦](https://github.com/pieroxy/lz-string),基于 LZ 的 javaScript 字符串的压缩算法.

-   有线兼容 lz-string 1.x: 由一解压与一解压压缩的任何东西 (对照测试套间中的参考执行进行核实).
-   相同的API, 完全输入, 无害环境管理和通用JS构建, 零依赖性, 有树可动摇性.
-   大约一半的原作来源:比特读者/写作员是共享的,而不是复制版.

## 安装

```bash
pnpm add @amoutonbrady/lz-string
```

## 使用量

```ts
import { compressToURL, decompressFromURL } from '@amoutonbrady/lz-string';

const compressed = compressToURL('hello world'); // safe to put in a query string as-is
const original = decompressFromURL(compressed); // 'hello world'
```

## API 密码

每个 `compress*` 函数返回 `''` 页:1 `null`编号 :`undefined`每一个 `decompress*` 函数 返回时 `''` 页:1 `null`编号 :`undefined`, (中文(简体) ), `null` 用于空入或腐败输入.

| 压缩 | 降压 | 产出 |
| --- | --- | --- |
| `compress(input: string): string` | `decompress(input: string): string | null` | 原始 UTF-16 代码单位, 最小但不能安全存储为文本 |
| `compressToUTF16(input: string): string` | `decompressFromUTF16(input: string): string | null` | 有效的 UTF-16, 安全 `localStorage` |
| `compressToBase64(input: string): string` | `decompressFromBase64(input: string): string | null` | 标准基数64 |
| `compressToURL(input: string): string` | `decompressFromURL(input: string): string | null` | URL 安全字母表 (单位:千美元)`+-$`),无粘接,不需要编码 |
| `compressToUint8Array(input: string): Uint8Array` | `decompressFromUint8Array(input: Uint8Array): string | null` | 二进制 |

`compressToURL` 被命名为 `compressToEncodedURIComponent` 在原始图书馆.

## 发展

```bash
pnpm install
pnpm test       # node:test, runs the TypeScript sources directly
pnpm typecheck
pnpm build      # tsdown: ESM + CJS + .d.ts, then publint + arethetypeswrong
```

发布: 击出版本, 推出 `v*` 标签。 这个 `release.yml` 工作流程的构建、测试和 通过 npm 信任的出版方式发布出处为 npm(没有可管理的迹象).

## 许可证

麻省理工学院

## 常见问题

### @amoutonbrady/lz-string 是什么？

Lz- string 的现代类型脚本端口:基于 LZ 的 JavaScript 字符串压缩

### 如何安装 @amoutonbrady/lz-string？

在项目目录运行 npm install @amoutonbrady/lz-string，或使用 pnpm add / yarn add / bun add。

### @amoutonbrady/lz-string 支持 TypeScript 吗？

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

### @amoutonbrady/lz-string 支持 ESM 还是 CommonJS？

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

### @amoutonbrady/lz-string 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @amoutonbrady/lz-string 可以商用吗？

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

### @amoutonbrady/lz-string 的下载量有多少？

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

### @amoutonbrady/lz-string 还在维护吗？

最新版本 0\.2\.0 发布于 2026/09/07（1 个月前）；至今共发布 3 个版本，其中过去 12 个月发布了 1 个；首次发布于 2021/01/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。