Zagorodnyi/filter-ast

选用指南

AI 根据 README 整理 · 2026/10/17 09:31:18

使用方式

通过npm或bun安装，以TypeScript或JavaScript导入命名导出函数使用。

查看 README 依据

# @sirzag/filter-ast Turns a declarative filter object with operator strings into a database-agnostic filter tree. ## Install ```sh npm install @sirzag/filter-ast ``` ```sh bun add @sirzag/filter-ast ``` ## Quick start ```ts import { buildAbstractFilterTree } from "@sirzag/filter-ast"; buildAbstractFilterTree({ status: "$in(active,pending)", age: "$gte(18)", name: "John", }); ``` ```js [ { joinLogic: 'and', conditions: [ { field: 'status', operator: 'in', value: [ 'active', 'pending' ] }, { field: 'age', operator: 'gte', value: 18 },

{ field: 'name', operator: 'eq', value: 'John' } ] } ] ``` The package has named exports only: `buildAbstractFilterTree`, `$and`, `$or`, `joinOr`, `isFilterGroup`, `QueryHelpers`, `FilterError`, and the types `FilterGroup`, `FilterCondition`, `FilterExpression`, `FilterValue`, `FilterFieldValue`, `FilterInput`, `LogicalOperator`, `Operator`, `ParsedOperator`. ## Filter syntax ### Bare values A value that is not an operator string becomes an `eq` condition and is passed through as is. `undefined` fields are dropped. ```ts

部署要求

需要Node.js或Bun环境，支持npm或bun包管理器。

查看 README 依据

# @sirzag/filter-ast Turns a declarative filter object with operator strings into a database-agnostic filter tree. ## Install ```sh npm install @sirzag/filter-ast ``` ```sh bun add @sirzag/filter-ast ``` ## Quick start ```ts import { buildAbstractFilterTree } from "@sirzag/filter-ast"; buildAbstractFilterTree({ status: "$in(active,pending)", age: "$gte(18)", name: "John", }); ``` ```js [ { joinLogic: 'and', conditions: [ { field: 'status', operator: 'in', value: [ 'active', 'pending' ] }, { field: 'age', operator: 'gte', value: 18 },

已知限制

$and和$or仅作为对象字面量的计算键使用，不可复用；输入类型仅编译时检查，运行时不做字段值验证；不提供SQL生成，字段名未消毒，需自行处理。

查看 README 依据

Reproduce with `bun run bench`: builds `dist`, prints the table on Bun, then on Node. Workloads are defined in [`bench/bench.mjs`](./bench/bench.mjs). ## Limitations - `$and` and `$or` work only as computed keys in object literals. They are not reusable symbols: each use creates a new key, so `obj[$and] = { a: 1 }` followed by `obj[$and]` returns `undefined`. - Any symbol key whose description is `"or"` is treated as an OR branch. `{ a: 1, [Symbol("or")]: { b: 2 } }` builds an OR of `a` and `b`.

- Input types are compile-time only. `FilterInput` rejects functions, symbols and plain objects as field values, but field values are not checked at runtime. - There are no adapters and no SQL generation. Field names are passed through unsanitized (`{ "name; DROP TABLE users": "x" }` → `field: 'name; DROP TABLE users'`). Never concatenate them into SQL. ## License [MIT](./LICENSE)