# @bitovi/sequelize-querystring-parser 中文文档

规范地址：https://npmcn.com/package/%40bitovi/sequelize-querystring-parser/

版本：0\.3\.6
npm 元数据更新时间：2026-05-21T14:19:19.362Z
中文译文更新时间：2026-11-08T04:37:53.772Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bitovi/sequelize-querystring-parser
原文对照：https://npmcn.com/package/%40bitovi/sequelize-querystring-parser/?lang=original

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

- 包体积（解压后）：44.6 kB，15 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2022-08-01T20:38:25.005Z
- 最新版本发布：2024-03-18T18:45:35.945Z
- 近 30 天下载量：4854（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：39（近 12 个月 0 个）

## 中文简介

这个图书馆建立在 [`@bitovi/querystring-parser`](https://github.com/bitovi/querystring-parser/tree/main/packages/querystring-parser#readme) 将 CRUD 相关查询字符串转换为 \[Sequelize ORM\] () 的结构化数据[https://sequelize.o (英语)](https://sequelize.o/)

## 安装

```sh
npm install @bitovi/sequelize-querystring-parser
```

也可以使用：`pnpm add @bitovi/sequelize-querystring-parser`、`yarn add @bitovi/sequelize-querystring-parser`、`bun add @bitovi/sequelize-querystring-parser`

## README

# 续作- querystring- parser

这个图书馆建立在 [`@bitovi/querystring-parser`](https://github.com/bitovi/querystring-parser/tree/main/packages/querystring-parser#readme) 将 CRUD 相关查询字符串转换为结构化数据 [排列ORM](https://sequelize.org/)。 。 。 .

-   [安装](https://npmcn.com/package/%40bitovi/sequelize-querystring-parser/#readme-installation)
-   [使用量](https://npmcn.com/package/%40bitovi/sequelize-querystring-parser/#readme-usage)
    -   [排序参数](https://npmcn.com/package/%40bitovi/sequelize-querystring-parser/#readme-sort-parameters)
    -   [倾角参数](https://npmcn.com/package/%40bitovi/sequelize-querystring-parser/#readme-pagination-parameters)
    -   [字段参数](https://npmcn.com/package/%40bitovi/sequelize-querystring-parser/#readme-fields-parameters)
    -   [包含参数](https://npmcn.com/package/%40bitovi/sequelize-querystring-parser/#readme-include-parameters)
    -   [过滤参数](https://npmcn.com/package/%40bitovi/sequelize-querystring-parser/#readme-filter-parameters)
-   [内容](https://github.com/bitovi/querystring-parser#readme)

## 安装

```sh
npm install @bitovi/sequelize-querystring-parser
```

如果您不打算使用此库, 请安装 [`@bitovi/querystring-parser`](https://github.com/bitovi/querystring-parser/tree/main/packages/querystring-parser#readme)。 。 。 .

## 使用量

```js
const querystringParser = require("@bitovi/sequelize-querystring-parser");
```

### 排序参数

参考文献:

-   [查询解析器 - 排序](https://github.com/bitovi/querystring-parser/tree/main/packages/querystring-parser#sort-parameters)
-   [JSON:API - 排序](https://jsonapi.org/format/#fetching-sorting)

```js
const result = querystringParser.parse("sort=-date,name");
console.log(result);
// {
//   orm: "sequelize",
//   data: {
//     order: [["date", "DESC"],["name","ASC"]]
//  },
//   errors: [],
// };
```

### 倾角参数

参考文献:

-   [查询解析器 - Pagination](https://github.com/bitovi/querystring-parser/tree/main/packages/querystring-parser#pagination-parameters)
-   [JSON:API - 铺设](https://jsonapi.org/format/#fetching-pagination)

```js
const result = querystringParser.parse("page[number]=1&page[size]=10");
console.log(result);
// {
//   orm: "sequelize",
//   data: {
//     offset: 0,
//     limit: 10
//  },
//   errors: []
// };
```

### 字段参数

参考文献:

-   [查询解析器 - 字段](https://github.com/bitovi/querystring-parser/tree/main/packages/querystring-parser#fields-parameters)
-   [JSON:API - Sparse 场集](https://jsonapi.org/format/#fetching-sparse-fieldsets)

```js
const result = querystringParser.parse("fields[]=id,name");
console.log(result);
// {
//   orm: "sequelize",
//   data: {
//     attributes: ["id","name"]
//  },
//   errors: []
// };
```

### 包含参数

参考文献:

-   [查询解析器 - 包含](https://github.com/bitovi/querystring-parser/tree/main/packages/querystring-parser#include-parameters)
-   [JSON:API - 包含相关资源](https://jsonapi.org/format/#fetching-includes)

```js
const result = querystringParser.parse("include=pets,dogs");
console.log(result);
// {
//   orm: "sequelize",
//   data: {
//     include: [
//       { association: "pets", include: [] },
//       { association: "dogs", include: [] }
//     ]
//  },
//   errors: []
// };
```

### 过滤参数

参考文献:

-   [查询字符串解析器 - 过滤器](https://github.com/bitovi/querystring-parser/tree/main/packages/querystring-parser#filter-parameters)
-   [JSON:API - 过滤](https://jsonapi.org/format/#fetching-filtering)

```js
const result = querystringParser.parse("filter=and(any('age','10','20'),equals('name','mike'))");
console.log(result);
// {
//   orm: "sequelize",
//   data: {
//     where: {
//       [Symbol(and)] : [
//         {
//           age: {
//             [Symbol(in)]: [10, 20]
//           }
//         },
//         {
//           name: {
//             [Symbol(eq)]: "mike"
//           }
//         }
//       ]
//     }
//  },
//   errors: []
// };
```

**说明**:数据库验证应在数据库呼叫之前或之后向图书馆传递查询.

**说明**编号: `Symbol()` 调用 [`Op` 从序列库导入](https://sequelize.org/docs/v6/core-concepts/model-querying-basics/),而不是 [Javascript 符号类](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol)。 。 。 .

## 示例

关于如何在您的工程中使用此库的更实际的例子可以找到 [这里](https://github.com/bitovi/querystring-parser/tree/main/examples)

## 进一步的文件

这个图书馆建立在 [`@bitovi/querystring-parser`](https://github.com/bitovi/querystring-parser/tree/main/packages/querystring-parser#readme)。参见其 [文档](https://github.com/bitovi/querystring-parser/tree/main/packages/querystring-parser#readme) 对于更多使用 `querystring-parser`。 。 。 .

## 常见问题

### @bitovi/sequelize-querystring-parser 是什么？

这个图书馆建立在 @bitovi/querystring-parser 将 CRUD 相关查询字符串转换为 \[Sequelize ORM\] \(\) 的结构化数据https://sequelize\.o \(英语\)

### 如何安装 @bitovi/sequelize-querystring-parser？

在项目目录运行 npm install @bitovi/sequelize-querystring-parser，或使用 pnpm add / yarn add / bun add。

### @bitovi/sequelize-querystring-parser 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bitovi\_\_sequelize-querystring-parser 是否存在。

### @bitovi/sequelize-querystring-parser 支持 ESM 还是 CommonJS？

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

### @bitovi/sequelize-querystring-parser 可以商用吗？

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

### @bitovi/sequelize-querystring-parser 的下载量有多少？

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

### @bitovi/sequelize-querystring-parser 还在维护吗？

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