# @fresha/api-tools-core 中文文档

规范地址：https://npmcn.com/package/%40fresha/api-tools-core/

版本：0\.7\.0
npm 元数据更新时间：2023-06-21T09:32:31.010Z
中文译文更新时间：2026-11-15T13:48:08.115Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fresha/api-tools-core
原文对照：https://npmcn.com/package/%40fresha/api-tools-core/?lang=original
项目主页：https://github.com/surgeventures/api-tools#readme
源码仓库：https://github.com/surgeventures/api-tools

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

- 包体积（解压后）：35.1 kB，23 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2022-07-17T11:48:11.729Z
- 最新版本发布：2023-06-21T09:32:30.848Z
- 近 30 天下载量：27126（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 0 个）

## 中文简介

核心项目功能

## 安装

```sh
npm install @fresha/api-tools-core
```

也可以使用：`pnpm add @fresha/api-tools-core`、`yarn add @fresha/api-tools-core`、`bun add @fresha/api-tools-core`

## README

# @ fresha/ api-tools- core

此软件包包含共享类型定义、函数和类型 其他项目 `api-tools` 软件包.

## 安装

```bash
$ npm install @fresha/api-tools-core
```

## 用法实例

```ts
import type { JSONRef } from '@fresha/api-tools-core';

const ref: JSONRef = { $ref: '#/components' };
```

## 类型

以下为类型列表. 关于他们的描述,请查阅 `src/types.ts`。 。 。 .

-   `Nullable<T>`
    
-   `CommonMarkString`
    
-   `URLString`
    
-   `ParametrisedURLString`
    
-   `EmailString`
    
-   `VersionString`
    
-   `DateTimeString`
    
-   `MIMETypeString`
    
-   `HTTPMethod`
    
-   `HTTPStatusCode`
    
-   `JSONPrimitive`
    
-   `JSONValue`
    
-   `JSONArray`
    
-   `JSONObject`
    
-   `JSONObjectRecord`
    
-   `JSONObjectArray`
    
-   `JSONPointerString`
    
-   `JSONRef`
    
-   `ObjectOrRef<T>`
    
-   `JSONAPIMeta`
    
-   `JSONAPILink`
    
-   `JSONAPIResourceID`
    
-   `JSONAPIResourceRelationship`
    
-   `JSONAPIServerResource`
    
-   `JSONAPIClientResource`
    
-   `JSONAPIResource`
    
-   `JSONAPIImplementationInfo`
    
-   `JSONAPITopLevelLinks`
    
-   `JSONAPIDataDocument`
    
-   `JSONAPIError`
    
-   `JSONAPIErrorDocument`
    
-   `JSONAPIDocument`
    
-   `Disposable`
    

## 类型警卫

以下为警卫名单. 更多信息请改为 `src/typeGuards.ts`。 。 。 .

-   `isJSONObject`
-   `isJSONValueArray`
-   `isJSONRef`
-   `isJSONAPIDataDocument`
-   `isJSONAPIErrorDocument`

## 杂项职能

-   `transformKeysDeep`
-   `camelCase`
-   `camelCaseDeep`
-   `kebabCase`
-   `kebabCaseDeep`

## 常见问题

### @fresha/api-tools-core 是什么？

核心项目功能

### 如何安装 @fresha/api-tools-core？

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

### @fresha/api-tools-core 支持 TypeScript 吗？

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

### @fresha/api-tools-core 支持 ESM 还是 CommonJS？

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

### @fresha/api-tools-core 可以商用吗？

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

### @fresha/api-tools-core 的下载量有多少？

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

### @fresha/api-tools-core 还在维护吗？

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