# side-channel-weakmap 中文文档

规范地址：https://npmcn.com/package/side-channel-weakmap/

版本：1\.0\.2
npm 元数据更新时间：2024-12-11T05:39:11.658Z
中文译文更新时间：2026-11-04T19:39:54.827Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/side-channel-weakmap
原文对照：https://npmcn.com/package/side-channel-weakmap/?lang=original
项目主页：https://github.com/ljharb/side-channel-weakmap#readme
源码仓库：https://github.com/ljharb/side-channel-weakmap

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

- 包体积（解压后）：14.7 kB，12 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 0\.4
- 运行依赖：5 个
- 首次发布：2024-12-10T22:15:39.856Z
- 最新版本发布：2024-12-11T05:39:11.495Z
- 近 30 天下载量：647461908（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

在侧通道中存储关于任何JS值的信息。如果可用，使用WeakMap。

## 安装

```sh
npm install side-channel-weakmap
```

也可以使用：`pnpm add side-channel-weakmap`、`yarn add side-channel-weakmap`、`bun add side-channel-weakmap`

## README

# side-channel-weakmap [![Version Badge](https://versionbadg.es/ljharb/side-channel-weakmap.svg)](https://npmjs.org/package/side-channel-weakmap)

[![github actions](https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/side-channel-weakmap)](https://github.com/ljharb/side-channel-weakmap/actions) [![coverage](https://codecov.io/gh/ljharb/side-channel-weakmap/branch/main/graphs/badge.svg)](https://app.codecov.io/gh/ljharb/side-channel-weakmap/) [![License](https://img.shields.io/npm/l/side-channel-weakmap.svg)](https://npmcn.com/package/side-channel-weakmap/LICENSE) [![Downloads](https://img.shields.io/npm/dm/side-channel-weakmap.svg)](https://npm-stat.com/charts.html?package=side-channel-weakmap)

[![npm badge](https://nodei.co/npm/side-channel-weakmap.png?downloads=true&stars=true)](https://npmjs.org/package/side-channel-weakmap)

在侧通道中存储关于任何JS值的信息。如果可用，使用WeakMap。

警告：此实现将泄漏内存，直到您 `delete` 这个 `key`。 使用 [`side-channel`](https://npmjs.com/side-channel) 以获得最佳可用策略。

## 开始

```sh
npm install --save side-channel-weakmap
```

## 使用/例子

```js
const assert = require('assert');
const getSideChannelList = require('side-channel-weakmap');

const channel = getSideChannelList();

const key = {};
assert.equal(channel.has(key), false);
assert.throws(() => channel.assert(key), TypeError);

channel.set(key, 42);

channel.assert(key); // does not throw
assert.equal(channel.has(key), true);
assert.equal(channel.get(key), 42);

channel.delete(key);
assert.equal(channel.has(key), false);
assert.throws(() => channel.assert(key), TypeError);
```

## 测试

克隆回购， `npm install`，然后跑 `npm test`

## 常见问题

### side-channel-weakmap 是什么？

在侧通道中存储关于任何JS值的信息。如果可用，使用WeakMap。

### 如何安装 side-channel-weakmap？

在项目目录运行 npm install side-channel-weakmap，或使用 pnpm add / yarn add / bun add。

### side-channel-weakmap 支持 TypeScript 吗？

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

### side-channel-weakmap 支持 ESM 还是 CommonJS？

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

### side-channel-weakmap 需要什么版本的 Node\.js？

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

### side-channel-weakmap 可以商用吗？

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

### side-channel-weakmap 的下载量有多少？

根据 npm 官方下载统计，side-channel-weakmap 在 2026/10/05 – 2026/11/03 这 30 天内被下载 647,461,908 次，日均约 21,582,064 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### side-channel-weakmap 还在维护吗？

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