# @emresandikci/pocketbase-query 中文文档

规范地址：https://npmcn.com/package/%40emresandikci/pocketbase-query/

版本：0\.5\.1
npm 元数据更新时间：2026-11-01T00:15:58.291Z
中文译文更新时间：2026-11-01T02:16:48.261Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：40.2 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-01-31T12:08:14.032Z
- 最新版本发布：2026-11-01T00:15:57.927Z
- 已发布版本数：7（近 12 个月 2 个）

## 中文简介

一个pocketbase查询生成器

## 安装

```sh
npm install @emresandikci/pocketbase-query
```

也可以使用：`pnpm add @emresandikci/pocketbase-query`、`yarn add @emresandikci/pocketbase-query`、`bun add @emresandikci/pocketbase-query`

## README

# Pocketbase查询

[![](https://img.shields.io/npm/v/@emresandikci/pocketbase-query?color=birgtgreen)](https://www.npmjs.com/package/@emresandikci/pocketbase-query) ![](https://img.shields.io/npm/l/@emresandikci/pocketbase-query) ![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg) [![](https://img.shields.io/twitter/follow/emresandikci.svg?style=social&label=Follow) ](https://twitter.com/emresand1kc1)[![](https://img.shields.io/badge/Product%20Hunt-DA552F?logo=producthunt&logoColor=fff)](https://www.producthunt.com/posts/pocketbase-query)

## 概述

`@emresandikci/pocketbase-query` 是一个小的，零依赖的TypeScript查询生成器 [PocketBase过滤器](https://pocketbase.io/docs/api-rules-and-filters/)． 它通过流畅的、可链接的API构建过滤器字符串，安全地转义值，并删除值为空的条件，这使得可选过滤器（搜索表单、表过滤器）保持简单。

它遵循PocketBase v0.40过滤器语法。

* * *

## 安装

```bash
npm i @emresandikci/pocketbase-query
```

```typescript
// ESM / TypeScript
import PocketbaseQuery from '@emresandikci/pocketbase-query';

// CommonJS
const PocketbaseQuery = require('@emresandikci/pocketbase-query').default;
```

* * *

## 使用

`getInstance<T>()` 返回一个新的查询生成器。 `T` 是您的记录类型，并为您提供对字段名称的自动完成和类型检查。每个调用都返回自己的实例，因此查询可以并行构建或嵌套构建。

```typescript
import PocketBase from 'pocketbase';
import PocketbaseQuery from '@emresandikci/pocketbase-query';

interface Post {
  title: string;
  status: string;
  comments: number;
  tags: string[];
  created: string;
}

const pb = new PocketBase('http://127.0.0.1:8090');

const filter = PocketbaseQuery.getInstance<Post>()
  .equal('status', 'active')
  .and()
  .greaterThan('comments', 50)
  .build();
// status="active" && comments>50

const posts = await pb.collection('posts').getFullList({
  filter,
  expand: 'comments_via_post',
});
```

### 可选的过滤器

具有空值的条件(`null`， `undefined`， `''`， `NaN`)和 `&&` / `||` 在它们周围留下空括号。你可以链接所有可能的过滤器，并让构建器丢弃未使用的过滤器：

```typescript
function buildFilter(form: { search?: string; status?: string; tag?: string }) {
  return PocketbaseQuery.getInstance<Post>()
    .openBracket()
    .like('title', form.search)
    .or()
    .anyLike('tags', form.tag)
    .closeBracket()
    .and()
    .equal('status', form.status)
    .build();
}

buildFilter({ search: 'pocketbase' }); // (title~"pocketbase")
buildFilter({ status: 'active' }); // status="active"
buildFilter({}); // ""
```

* * *

## 字段和值

### 字段

`field` 是…的钥匙 `T`，可选：

-   一个修饰词: `title:lower` (不区分大小写), `tags:length` (项数), `tags:each` (每项)
-   关系路径： `author.name`

```typescript
query.like('title:lower', 'news').and().greaterThan('tags:length', 2).and().equal('author.name', 'John');
// title:lower~"news" && tags:length>2 && author.name="John"
```

### 值

`value` 可以 `string | number | boolean | Date | null | undefined`.

| 价值 | 输出 |
| --- | --- |
| `'active'` | `"active"`逃脱了 `pb.filter()` 在官方SDK中，所以用户输入中的引号和反斜杠不能脱离字符串 |
| `50`， `true` | `50`， `true` (无报价) |
| `new Date('2026-01-02T03:04:05Z')` | `"2026-01-02 03:04:05.000Z"` （PocketBase日期时间格式） |
| `'@now'`， `'@todayStart'`,…… | `@now`， `@todayStart` （日期时间宏，不带引号） |
| `null`， `undefined`， `''`， `NaN` | 跳过条件 |

支持宏: `@now`， `@second`， `@minute`， `@hour`， `@weekday`， `@day`， `@month`， `@year`， `@yesterday`， `@tomorrow`， `@todayStart`， `@todayEnd`， `@monthStart`， `@monthEnd`， `@yearStart`， `@yearEnd`.

编辑器在键入值时建议使用这些宏，在键入字段时建议使用带有修饰符的字段名。任何其他字符串仍然作为正常值工作。

```typescript
query.greaterThanOrEqual('created', '@todayStart').and().lessThan('created', new Date('2026-12-31'));
// created>=@todayStart && created<"2026-12-31 00:00:00.000Z"
```

* * *

## API

### 比较的方法

所有的方法 `(field, value)` 并返回建造者进行链锁。

| 方法 | 运营商 | 方法（数组字段的任何项） | 运营商 |
| --- | --- | --- | --- |
| `equal` | `=` | `anyEqual` | `?=` |
| `notEqual` | `!=` | `anyNotEqual` | `?!=` |
| `greaterThan` | `>` | `anyGreaterThan` | `?>` |
| `greaterThanOrEqual` | `>=` | `anyGreaterThanOrEqual` | `?>=` |
| `lessThan` | `<` | `anyLessThan` | `?<` |
| `lessThanOrEqual` | `<=` | `anyLessThanOrEqual` | `?<=` |
| `like` | `~` | `anyLike` | `?~` |
| `notLike` | `!~` | `anyNotLike` | `?!~` |

`like` / `notLike` 匹配部分：PocketBase将值封装在 `%` 除非你加上 `%` 通配符(`'Lorem%'`）。

```typescript
query.anyEqual('tags', 'sale');
// tags?="sale"
```

### `in(field, values)`

加入一个 `like` 每个值的条件 `||`． 空值将被跳过。

```typescript
query.in('status', ['draft', 'review']);
// status~"draft" || status~"review"
```

因为它使用 `~`， `'act'` 同时匹配 `active` 和 `inactive`。使用 `equal` 与 `or()` 精确匹配。

### `customFilter(filter)`

为构建器未涵盖的语法追加一个原始筛选器字符串，例如 `strftime()`， `geoDistance()`， `@request.*` 或者 `@collection.*`． 它是 **不逃**，所以永远不要传递不可信的输入。

```typescript
query
  .customFilter("strftime('%Y-%m', created) = '2026-01'")
  .and()
  .customFilter('geoDistance(address.lon, address.lat, 23.32, 42.69) < 25');
```

### 分组和逻辑

| 方法 | 增加了 |
| --- | --- |
| `and()` | `&&` |
| `or()` | `||` |
| `openBracket()` / `closeBracket()` | `(` / `)` |

```typescript
query
  .openBracket()
  .equal('status', 'active')
  .or()
  .equal('status', 'pending')
  .closeBracket()
  .and()
  .greaterThan('comments', 50)
  .build();
// (status="active" || status="pending") && comments>50
```

### 输出

| 方法 | 返回 |
| --- | --- |
| `build()` | 最后一个过滤器字符串。移除剩余的操作符和空括号，然后重置构造器。 |
| `getQuery()` | 迄今为止构建的原始字符串，没有清除或重置。用于调试。 |
| `getLastQueryValue()` | 添加到查询中的最后一个值。 |

* * *

## 开发

```bash
npm ci
npm test           # jest
npm run typecheck  # tsc
npm run validate   # prettier --check + eslint
npm run build      # tsup -> dist/ (ESM + CJS + types)
```

## 释放

版本和npm发布是自动使用的 [semantic-release](https://github.com/semantic-release/semantic-release)． 每一次推到 `main` 运行测试，并且自最后一个标记之后的提交包含 `fix:`， `feat:` 或者突破性的变化，下一个版本发布到NPM，并带有出处、标记和添加 [CHANGELOG.md](https://npmcn.com/package/%40emresandikci/pocketbase-query/CHANGELOG.md)． 拉取请求会得到一个关于其将要发布的版本的注释。

提交与 `npm run commit` 或写 [传统的提交](https://www.conventionalcommits.org/) 用手。

* * *

## 许可证

MIT许可证

## 常见问题

### @emresandikci/pocketbase-query 是什么？

一个pocketbase查询生成器

### 如何安装 @emresandikci/pocketbase-query？

在项目目录运行 npm install @emresandikci/pocketbase-query，或使用 pnpm add / yarn add / bun add。

### @emresandikci/pocketbase-query 支持 TypeScript 吗？

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

### @emresandikci/pocketbase-query 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @emresandikci/pocketbase-query 可以商用吗？

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

### @emresandikci/pocketbase-query 还在维护吗？

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