# @kdesigner/core 中文文档

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

版本：0\.0\.3
npm 元数据更新时间：2026-11-01T14:40:47.306Z
中文译文更新时间：2026-11-01T15:18:07.814Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40kdesigner/core
原文对照：https://npmcn.com/package/%40kdesigner/core/?lang=original

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

- 包体积（解压后）：1 MB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0 \<25\.0\.0
- 运行依赖：6 个
- peer 依赖：vue \>=3\.0\.0，vue-router \>=4\.0\.0
- 首次发布：2026-09-29T06:11:14.480Z
- 最新版本发布：2026-11-01T14:40:47.154Z
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

KDesigner 网络请求工具库 - 基于 axios 的 HTTP 客户端封装

## 安装

```sh
npm install @kdesigner/core
```

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

## README

# @kdesigner/core

![License](https://img.shields.io/badge/license-MIT-blue.svg) ![TypeScript](https://img.shields.io/badge/typescript-%5E5.9.2-blue.svg) ![Version](https://img.shields.io/badge/npm-v/@kdesigner/core-blue.svg)

KDesigner 网络请求库 - 基于 axios 的 HTTP 客户端封装，面向 AMIS 场景提供 fetcher 适配与业务 API。

## ✨ 特性

-   🚀 **基于 axios** - 稳定可靠的底层请求实现
-   🔌 **AMIS fetcher 适配** - `ajaxFetch` / `fetcherOk` / `responseOk` 等开箱即用的适配层
-   🧩 **业务 API 封装** - 内置 `UserApis`、`PageApis` 等常用接口
-   💾 **请求缓存** - `withPageCache` / `withDictCache` 提供页面与字典级缓存
-   🛡️ **TypeScript 支持** - 完整的类型定义（`FetcherRequest` / `FetcherResult` 等）和类型推导
-   ⚙️ **高度可定制** - 支持拦截器、多实例、取消令牌
-   🔄 **框架无关** - 可以在 Vue / React 等各种框架中使用

## 📦 安装

```bash
pnpm add @kdesigner/core
```

## 🚀 快速开始

```typescript
import { ajaxFetch, UserApis, fetcherOk } from '@kdesigner/core'

// 1. 作为 AMIS fetcher 使用
const result = await ajaxFetch({
  url: '/api/users',
  method: 'get'
})

// 2. 使用内置业务 API
const user = await UserApis.getCurrentUser()

// 3. 构造标准响应
fetcherOk({ status: 0, data: user })
```

## 📚 主要模块

| 模块 | 说明 |
| --- | --- |
| `ajax` | axios 实例、`ajaxFetch` / `ajaxRequest`、取消令牌 |
| `api` | `UserApis` / `PageApis` 业务接口，`withPageCache` / `withDictCache` 缓存工具 |
| `adapter` | `registerAdapter` 等运行时适配注册 |
| `graphql` | GraphQL 请求支持 |
| `loader` | 资源加载器 |
| `scope` / `schema-type` | 作用域与 Schema 类型定义 |

## 🛠 开发指南

```bash
# 构建
pnpm build

# 测试
pnpm test

# 代码检查
pnpm lint
```

## 📝 许可证

MIT

## 常见问题

### @kdesigner/core 是什么？

KDesigner 网络请求工具库 - 基于 axios 的 HTTP 客户端封装

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

在项目目录运行 npm install @kdesigner/core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vue（\>=3\.0\.0）、vue-router（\>=4\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

### @kdesigner/core 需要什么版本的 Node\.js？

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

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

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

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

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