# @clipboard-health/json-api 中文文档

规范地址：https://npmcn.com/package/%40clipboard-health/json-api/

版本：2\.11\.18
npm 元数据更新时间：2026-11-05T13:14:08.810Z
中文译文更新时间：2026-11-10T01:52:20.769Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：14.3 kB，14 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：qs ^6\.14
- 首次发布：2024-08-23T13:15:43.558Z
- 最新版本发布：2026-11-05T13:14:08.592Z
- 近 30 天下载量：27020（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：469（近 12 个月 382 个）

## 中文简介

符合JSON:API规格的TypeScript友好公用设备.

## 安装

```sh
npm install @clipboard-health/json-api
```

也可以使用：`pnpm add @clipboard-health/json-api`、`yarn add @clipboard-health/json-api`、`bun add @clipboard-health/json-api`

## README

# @clipboard-health/json-api 页面存档备份,存于互联网档案馆

用于遵守《公约》的方便脚本工具 [亚庇:](https://jsonapi.org/) 规格.

## 目录

-   [安装](https://npmcn.com/package/%40clipboard-health/json-api/#readme-install)
-   [使用量](https://npmcn.com/package/%40clipboard-health/json-api/#readme-usage)
    -   [查询助手](https://npmcn.com/package/%40clipboard-health/json-api/#readme-query-helpers)
-   [地方发展指挥部](https://npmcn.com/package/%40clipboard-health/json-api/#readme-local-development-commands)

## 安装

```bash
npm install @clipboard-health/json-api
```

## 使用量

### 查询助手

从客户打电话 `stringifyQuery` 转换自 `JsonApiQuery` 改为 `URLSearchParams`数字 :

```ts
import { deepEqual } from "node:assert/strict";

import { stringifyQuery } from "@clipboard-health/json-api";

import type { ClientJsonApiQuery } from "../src/lib/types";

const [date1, date2] = ["2024-01-01", "2024-01-02"];
const query: ClientJsonApiQuery = {
  fields: { user: ["age", "dateOfBirth"] },
  filter: {
    age: 2,
    dateOfBirth: {
      gt: date1,
      lt: date2,
    },
    isActive: true,
  },
  include: "article",
  page: {
    size: 10,
  },
  sort: "-age",
};

deepEqual(
  stringifyQuery(query),
  new URLSearchParams(
    `fields[user]=age,dateOfBirth&filter[age]=2&filter[dateOfBirth][gt]=${date1}&filter[dateOfBirth][lt]=${date2}&filter[isActive]=true&include=article&page[size]=10&sort=-age`,
  ).toString(),
);
```

从服务器呼叫 `parseQuery` 转换自 `URLSearchParams` 改为 `ServerJsonApiQuery`数字 :

```ts
import { deepEqual } from "node:assert/strict";

import { parseQuery } from "@clipboard-health/json-api";

import type { ServerJsonApiQuery } from "../src/lib/types";

const [date1, date2] = ["2024-01-01", "2024-01-02"];
// The URLSearchParams constructor also supports URL-encoded strings
const searchParams = new URLSearchParams(
  `fields[user]=age,dateOfBirth&filter[age]=2&filter[dateOfBirth][gt]=${date1}&filter[dateOfBirth][lt]=${date2}&filter[isActive]=true&include=article&page[size]=10&sort=-age`,
);

const query: ServerJsonApiQuery = parseQuery(searchParams.toString());

deepEqual(query, {
  fields: { user: ["age", "dateOfBirth"] },
  filter: {
    age: "2",
    dateOfBirth: { gt: date1, lt: date2 },
    isActive: "true",
  },
  include: "article",
  page: {
    size: "10",
  },
  sort: "-age",
});
```

## 地方发展指挥部

见 [`package.json`](https://npmcn.com/package/%40clipboard-health/json-api/package.json) `scripts` 用于命令列表.

## 常见问题

### @clipboard-health/json-api 是什么？

符合JSON:API规格的TypeScript友好公用设备\.

### 如何安装 @clipboard-health/json-api？

在项目目录运行 npm install @clipboard-health/json-api，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：qs（^6\.14）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @clipboard-health/json-api 支持 TypeScript 吗？

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

### @clipboard-health/json-api 支持 ESM 还是 CommonJS？

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

### @clipboard-health/json-api 可以商用吗？

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

### @clipboard-health/json-api 的下载量有多少？

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

### @clipboard-health/json-api 还在维护吗？

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