# @garfish/core 中文文档

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

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

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

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

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

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

## 中文简介

核心模块.

## 安装

```sh
npm install @garfish/core
```

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

## README

# `@garfish/core`

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

## 使用量

```shell
$ yarn add @garfish/core @garfish/cjs-app @garfish/router @garfish/browser-vm @garfish/browser-snapshot
```

```js
import Garfish from '@garfish/core';
import { GarfishRouter } from '@garfish/router';
import { GarfishBrowserVm } from '@garfish/browser-vm';
import { GarfishBrowserSnapshot } from '@garfish/browser-snapshot';

const GarfishInstance = new Garfish({
  apps,
  plugins: [GarfishRouter(), GarfishBrowserVm(), GarfishBrowserSnapshot()],
});
```

## 装入App

```js
import Garfish from '@garfish/core';
import { GarfishBrowserVm } from '@garfish/browser-vm';

const GarfishInstance = new Garfish({
  plugins: [GarfishBrowserVm()],
  beforeLoad: async (appInfo, options) => {
    // `return false` will prevent the app from loading
    // return false;
  },
  afterLoad: (appInfo, options) => {},
  beforeEval: (appInfo, code, env, url, options) => {},
  afterEval: (appInfo, code, env, url, options) => {},
  beforeMount: (appInfo, app) => {},
  afterMount: (appInfo, app) => {},
  beforeUnmount: (appInfo, app) => {},
  afterUnmount: (appInfo, app) => {},
  errorLoadApp: (err, appInfo) => console.error(err),
  errorMountApp: (err, appInfo) => console.error(err),
  errorUnmountApp: (err, appInfo) => console.error(err),
  errorExecCode: (err, appInfo) => console.error(err),
});

// `appName` is globally unique.
GarfishInstance.loadApp('appName', 'https://xx.html').then(async (app) => {
  if (!app) return;
  let mountSuccess;
  try {
    mountSuccess = await app.mount();
  } catch (e) {
    // If you add the `errorMountApp` hook, no error will be thrown here
    console.log(e);
  }

  if (mountSuccess) {
    document.body.appendChild(app.appContainer);
    // unmount
    setTimeout(() => {
      const unmountSuccess = app.unmout();
      console.log(unmountSuccess);
    }, 1000);
  }
});
```

也可以通过更复杂的参数.

```js
GarfishInstance.loadApp('appName', {
  cache: true,
  entry: 'https://xx.html',
  domGetter: '#appContainer', // When the child application is rendered, it will be mounted here
}).then(async (app) => {
  if (!app) return;
  // ...
});
```

## 常见问题

### @garfish/core 是什么？

核心模块\.

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

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

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

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

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

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

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

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

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

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

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

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

