# @garfish/loader 中文文档

规范地址：https://npmcn.com/package/%40garfish/loader/

版本：1\.19\.12
npm 元数据更新时间：2026-08-04T07:27:28.529Z
中文译文更新时间：2026-11-15T23:22:46.646Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40garfish/loader
原文对照：https://npmcn.com/package/%40garfish/loader/?lang=original
项目主页：http://garfish.bytedance.com/
源码仓库：https://github.com/bytedance/garfish

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

- 包体积（解压后）：42.3 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2021-05-07T07:23:17.998Z
- 最新版本发布：2026-08-04T07:27:28.180Z
- 近 30 天下载量：10364（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：376（近 12 个月 2 个）

## 中文简介

装载舱.

## 安装

```sh
npm install @garfish/loader
```

也可以使用：`pnpm add @garfish/loader`、`yarn add @garfish/loader`、`bun add @garfish/loader`

## README

# `@garfish/loader`

[![NPM version](https://img.shields.io/npm/v/@garfish/loader.svg?style=flat-square)](https://www.npmjs.com/package/@garfish/loader)

## 使用量

```js
import { Loader } from '@garfish/loader';

const loader = new Loader({
  maxSize: 1024 * 1024 * 15, // default number is "1024 * 1024 * 15"
});

loader.hooks.usePlugin({
  name: 'test-plugin1',

  beforeLoad({ url, config }) {
    // You can changed the request config
    if (url.includes('xx')) {
      url = url.replace('xx', '');
    }
    return { url, config };
  },

  loaded(data) {
    const { result, value } = data;
    data.n = 1;
    return data;
  },
});

loader.hooks.usePlugin({
  name: 'test-plugin2',

  loaded(data) {
    console.log(data.n); // 1
    // The "data.value" will be cached this time.
    // So, you can transform the request result.
    return data;
  },
});

loader.load({scope: 'appName', url: 'https://xxx'}).then((result) => {
  console.log(result); // 2
});
```

## 清除缓存

```js
const loader = new Loader();

loader.clear('appName'); // Clear all cached resources under "appName"
loader.clear('appName', 'js'); // Clear all "js" cache resources under "appName"

loader.clearAll(); // Clear all cached resources
loader.clearAll('css'); // Clear all "css" cached resources
```

## 常见问题

### @garfish/loader 是什么？

装载舱\.

### 如何安装 @garfish/loader？

在项目目录运行 npm install @garfish/loader，或使用 pnpm add / yarn add / bun add。

### @garfish/loader 支持 TypeScript 吗？

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

### @garfish/loader 支持 ESM 还是 CommonJS？

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

### @garfish/loader 可以商用吗？

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

### @garfish/loader 的下载量有多少？

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

### @garfish/loader 还在维护吗？

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

