@garfish/core

中文文档
1.19.12发布于 2026/08/04MITTypeScriptESM + CJS近 30 天下载 1万

core module.

原始使用文档

@garfish/core

NPM version

Usage

$ yarn add @garfish/core @garfish/cjs-app @garfish/router @garfish/browser-vm @garfish/browser-snapshot
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()],
});

loadApp

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);
  }
});

You can also pass more complex parameters.

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 共发布 392 个版本,首次发布于 2021/01/14;过去 12 个月发布了 2 个版本。

版本发布日期距今
1.19.12latest2026/08/043 个月前
1.19.82026/01/0410 个月前
1.19.72025/09/111.2 年前
1.19.7-beta-20250911075322.0beta2025/09/111.2 年前
1.19.62025/08/271.2 年前
1.19.6-beta-20250826044806.02025/08/261.2 年前

其他发布通道:alpha → 0.1.0-alpha.0,null → 0.1.9,prerelease → 1.0.23-beta.1,prepatch → 1.2.7-beta-1640069055250.0,patch → 1.2.8,beta → 1.19.7-beta-20250911075322.0。

关于 @garfish/core 的常见问题

@garfish/core 是什么?

core module.

如何安装 @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 和提交记录判断。