# @adonis-agora/filter-client 中文文档

规范地址：https://npmcn.com/package/%40adonis-agora/filter-client/

版本：0\.4\.0
npm 元数据更新时间：2026-10-17T03:49:39.517Z
中文译文更新时间：2026-11-06T22:48:19.287Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40adonis-agora/filter-client
原文对照：https://npmcn.com/package/%40adonis-agora/filter-client/?lang=original
项目主页：https://davidecarvalho.github.io/agora/docs/filter
源码仓库：https://github.com/DavideCarvalho/adonis-agora-filter

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

- 包体积（解压后）：121 kB，41 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：0 个
- peer 依赖：@tanstack/table-core \>=8\.0\.0
- 首次发布：2026-07-15T12:19:45.811Z
- 最新版本发布：2026-10-17T03:49:39.136Z
- 近 30 天下载量：2209（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

@ados-agora/ filter 的客户端查询构建器——构建过滤查询字符串,可选的 TanStack 表状态同步.

## 安装

```sh
npm install @adonis-agora/filter-client
```

也可以使用：`pnpm add @adonis-agora/filter-client`、`yarn add @adonis-agora/filter-client`、`bun add @adonis-agora/filter-client`

## README

# `@adonis-agora/filter-client`

框架不可知客户端查询构建器 [`@adonis-agora/filter`](https://github.com/DavideCarvalho/adonis-filter) ——能流畅地构建过滤器/sort/pgination查询字符串,带有可选的 TanStack 表态同步 .

```ts
import { filterQuery } from '@adonis-agora/filter-client'

const qs = filterQuery()
  .where('status', 'eq', 'active')
  .where('age', 'gte', 18)
  .sort('createdAt', 'desc')
  .page(1, 25)
  .toQueryString()
// → filter[status]=active&filter[age][gte]=18&sort=-createdAt&page=1&size=25
```

## 许可证

麻省理工学院

## 常见问题

### @adonis-agora/filter-client 是什么？

@ados-agora/ filter 的客户端查询构建器——构建过滤查询字符串,可选的 TanStack 表状态同步\.

### 如何安装 @adonis-agora/filter-client？

在项目目录运行 npm install @adonis-agora/filter-client，或使用 pnpm add / yarn add / bun add。

### @adonis-agora/filter-client 支持 TypeScript 吗？

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

### @adonis-agora/filter-client 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @adonis-agora/filter-client 需要什么版本的 Node\.js？

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

### @adonis-agora/filter-client 可以商用吗？

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

### @adonis-agora/filter-client 的下载量有多少？

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

### @adonis-agora/filter-client 还在维护吗？

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