pbf下載 - pbf原始碼下載

pbf

其他源碼

1.3.2

下載

PBF

用於序列化和反序列化 PocketBase 過濾器語法的函式庫。

主要特點

支援所有 PocketBase 過濾運算子和表達式
同時支援節點和瀏覽器
為建立過濾器提供流暢且（幾乎）類型安全的 API
可用於序列化和反序列化濾波器
TypeScript 支援

安裝

您可以使用npm或yarn輕鬆安裝PBF：

npm install pbf

或者

yarn add pbf

用法

PBF 使得使用 PocketBase 過濾器語法變得簡單。以下是如何開始的快速範例：

 import * as pbf from "@nedpals/pbf" ;
import PocketBase from "pocketbase" ;

const pb = new PocketBase ( "<pocketbase url>" ) ;

const result = await pb . collection ( 'example' ) . getList ( 1 , 20 , {
    filter : pbf . stringify ( pbf . and (
        pbf . eq ( 'status' , true ) ,
        pbf . gt ( 'created' , new Date ( "2022-08-01" ) )
    ) ) // status = true && created > "2022-08-01 10:00:00.000Z"
} ) ;

否定過濾器

若要否定篩選器（例如，等於、不等於、或），您可以使用not函數。這不會否定該值，而只會否定所使用的運算子。

 import * as pbf from "@nedpals/pbf" ;

pbf . stringify ( pbf . not ( pbf . eq ( "is_repost" , false ) ) ) // is_repost = false

條件過濾器生成

在某些情況下，您希望建立一個搜尋過濾器，其中一些過濾器會透過短路有條件地啟用。您可以透過在呼叫運算子之前新增.maybe修飾符來實現此目的。這將過濾掉任何錯誤值並輸出適當的過濾器。

 import * as pbf from "@nedpals/pbf" ;

pbf . stringify ( pbf . and . maybe (
    false && pbf . eq ( 'f' , 4 ) ,
    null ,
    pbf . eq ( 'd' , 1 ) ,
    0 ,
    pbf . not ( pbf . eq ( 'e' , 1 ) ) ,
) ) ; // d = 1 && e != 1

比較多個值

PBF 無需重複編寫相同欄位的多個比較過濾器，而是透過either修飾符提供了一種簡單的捷徑。

 import * as pbf from "@nedpals/pbf" ;

// shortcut for pbf.or(pbf.eq("size", "L"), pbf.eq("size", "XL"), pbf.eq("size", "XXL"))
pbf . stringify ( pbf . eq . either ( "size" , [ "L" , "XL" , "XXL" ] ) ) ; // (size = "L" || size = "XL") || size = "XXL"

反序列化/解析原始過濾器字串

PBF 也支援將原始過濾器字串解析為正確的 PBF 格式。當您想要從 URL 搜尋查詢進行解析或只是想要建立類似 PocketBase 的搜尋體驗時，這非常有用：

 import * as pbf from "@nedpals/pbf" ;

const result = pbf . parse ( "title = 'example'" ) ; // equivalent to eq("title", "example");

// You can also inject/bind values to placeholders
const resultB = pbf . parse ( "title = {:title}" , { title : "Foo bar" } ) // equivalent of eq("title", "Foo bar")

格式

為了使序列化/反序列化成為可能，PBF 將其儲存為遵循語法樹格式的對象，以區分邏輯、比較和容器化/括號過濾器。

 // Taken and modified from the source code for brevity
type FilterValue = number | boolean | string | Date | null ;
type Filter = ComparisonFilter | LogicalFilter | ContainerFilter ;
type Metadata = Record < string , any >

// eg. a = 1
interface ComparisonFilter {
    field : string
    op : Operator
    value : FilterValue
    meta ?: Metadata
}

// eg. a > 1 && b = 2
interface LogicalFilter {
    lhs : Filter
    op : Operator
    rhs : Filter
    meta ?: Metadata
}

// eg. (c = 3)
interface ContainerFilter {
    op : Operator
    filter : Filter
    meta ?: Metadata
}

這也使得手工製作過濾器變得更容易，特別是在建立動態的多面過濾器時：

 const filter : Filter = {
    op : "and" ,
    lhs : {
        op : "gte" ,
        field : "shoe_size" ,
        value : 20
    } ,
    rhs : {
        op : "eq" ,
        field : "color" ,
        value : "burgundy"
    }
}

pbf . stringify ( filter ) // shoe_size >= 20 && color = "burgundy"