# @adonis-agora/filter 中文文档

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

版本：0\.11\.2
npm 元数据更新时间：2026-10-27T22:34:44.555Z
中文译文更新时间：2026-11-05T23:45:40.725Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：614 kB，168 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：0 个
- peer 依赖：@adonisjs/core ^7\.3\.0，@adonisjs/lucid ^22\.0\.0
- 首次发布：2026-07-15T12:12:37.321Z
- 最新版本发布：2026-10-27T22:34:44.203Z
- 近 30 天下载量：9109（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

AdonisJS——斯派蒂式输入的服务器侧式查询过滤/排序/涂鸦,一个Lucid适配器,和字段允许列表. 阿戈拉生态系统的一部分.

## 安装

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

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

## README

# `@adonis-agora/filter`

[![npm version](https://img.shields.io/npm/v/@adonis-agora/filter)](https://www.npmjs.com/package/@adonis-agora/filter) [![npm downloads](https://img.shields.io/npm/dm/@adonis-agora/filter)](https://www.npmjs.com/package/@adonis-agora/filter) [![CI](https://github.com/DavideCarvalho/adonis-agora-filter/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/DavideCarvalho/adonis-agora-filter/actions/workflows/ci.yml) [![license](https://img.shields.io/npm/l/@adonis-agora/filter)](https://www.npmjs.com/package/@adonis-agora/filter)

AdonisJS 的服务器端查询过滤、排序和页码。 解析 Spatie/JSON:API 查询 `@adonis-agora/filter-client` 建造者发射,应用到 通过允许列表进行 Lucid 查询,并解析偏移或密钥集( cursor) 帕吉纳.

```ts
import { parseFilterRequest, applyFilter } from '@adonis-agora/filter'

const input = parseFilterRequest(ctx.request.qs())
const query = User.query()
const { page, size } = applyFilter(query, input, {
  allowed: ['name', 'email', 'age'],
  searchable: ['name', 'email'],
})
return query.paginate(page, size)
```

### 可连锁宏( 可选)

登记 `FilterProvider` 获得方法调用形式 `applyFilterFromRequest` 在任何Lucid查询构建器上——相同的操作,但是 可链:

```ts
// adonisrc.ts → providers
() => import('@adonis-agora/filter/filter_provider')
```

```ts
// filter + sort + search, then keep chaining:
const rows = await User.query()
  .where('tenantId', tenant.id)
  .applyFilterFromRequest(userFilter, ctx)
  .orderBy('createdAt', 'desc')

// filter + paginate in one terminal call (returns Lucid's paginator):
const page = await User.query().filterPaginate(userFilter, ctx)
```

`applyFilterFromRequest` 返回查询(已解析但未应用); `filterPaginate` 用解析的值页,返回了Lucid的活化器——它 首先读取页面并跳过 `COUNT(*)` 当页回短。 免费 函数工作时没有提供者——宏只添加可连锁糖,所以 `@adonisjs/lucid` 保持可选的对等点.

运算符:等同/非等同,包含/iContains/startsWith/endsWith,gt/gte/lt/lte, 在/不在Between之间,在/不在/Is AnyOf,是Null/isNotNull/isEmpty/isNotEmpty,加 和/或组成。 这个 `allowed`编号 :`sortable`编号 :`searchable` 列表为安全 边界。 路西德捆绑是结构性的(`QueryBuilderLike`因此,任何 Lucid 查询 建设者工程和适配器可进行单位测试.

### 清单

`@adonis-agora/filter/in-memory` 运行一个普通阵列的相同输入——a 记忆 `QueryBuilderLike` 跑步者像路西德的查询:

```ts
import { defineCollection, filterInMemory } from '@adonis-agora/filter/in-memory'

const users = defineCollection<UserRow>({
  fields: { name: 'string', age: 'number', fullName: { type: 'string', get: (u) => u.first + ' ' + u.last } },
})
const page = filterInMemory(users, rows, input, { allowed: ['name', 'age', 'fullName'] })
// { data, meta: { total, perPage, currentPage, lastPage, firstPage } }
```

见 [仓库读取器](https://github.com/DavideCarvalho/adonis-filter)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

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

AdonisJS——斯派蒂式输入的服务器侧式查询过滤/排序/涂鸦,一个Lucid适配器,和字段允许列表\. 阿戈拉生态系统的一部分\.

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

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

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

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

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

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

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

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

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

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

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

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

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

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