# read-cache 中文文档

规范地址：https://npmcn.com/package/read-cache/

版本：1\.0\.2
npm 元数据更新时间：2026-08-19T18:13:55.705Z
中文译文更新时间：2026-11-05T16:43:47.524Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：4.3 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2016-01-11T01:53:14.064Z
- 最新版本发布：2026-08-19T18:13:55.300Z
- 近 30 天下载量：171156411（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 2 个）

## 中文简介

读取和缓存文件的全部内容直至修改

## 安装

```sh
npm install read-cache
```

也可以使用：`pnpm add read-cache`、`yarn add read-cache`、`bun add read-cache`

## README

# 读取缓存 [![CI](https://github.com/TrySound/read-cache/actions/workflows/ci.yml/badge.svg)](https://github.com/TrySound/read-cache/actions/workflows/ci.yml)

读取和缓存文件的全部内容,直到修改为止.

## 安装

```
$ npm i read-cache
```

## 使用量

```js
// foo.js
var readCache = require('read-cache');

readCache('foo.js').then(function (contents) {
    console.log(contents);
});
```

## API 密码

### 读取缓存( 路径\[, 编码\] )

返回符合文件内容的保证 .

### 读取Cache.sync(路径\[,编码\])

返回文件的内容.

### 读取Cache.get(路径\[,编码\])

返回缓存文件的内容或无效.

### 已读 Cache. clear ()

清除缓存的内容.

## 许可证

麻省理工学院 [博格丹·查德金](mailto:opensource@trysound.io)

## 常见问题

### read-cache 是什么？

读取和缓存文件的全部内容直至修改

### 如何安装 read-cache？

在项目目录运行 npm install read-cache，或使用 pnpm add / yarn add / bun add。

### read-cache 支持 TypeScript 吗？

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

### read-cache 支持 ESM 还是 CommonJS？

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

### read-cache 可以商用吗？

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

### read-cache 的下载量有多少？

根据 npm 官方下载统计，read-cache 在 2026/10/07 – 2026/11/05 这 30 天内被下载 171,156,411 次，日均约 5,705,214 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### read-cache 还在维护吗？

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