WhereFilterBuilder

Builder lọc Where, dùng để thêm, sửa, xóa điều kiện lọc cấp hàng. Lọc Where có hiệu lực trước khi query dữ liệu và dùng để lọc dữ liệu gốc

Phương thức

constructor

Định nghĩa:

constructor(doc: Y.Doc, dsl: Y.Map<any>)

Tham số:

Tham sốKiểuMô tả
docY.Doc-
dslY.Map-

getConditions

Định nghĩa:

getConditions(): Y.Array<any>

Trả về: Y.Array<any>

add

Thêm một điều kiện lọc Where

Định nghĩa:

add(field: string, callback: (node: WhereFilterNodeBuilder) => void): WhereFilterBuilder

Trả về: WhereFilterBuilder

Tham số:

Tham sốKiểuMô tả
fieldstring- Tên field
callback(node: WhereFilterNodeBuilder) => void- Hàm callback

addGroup

Thêm một nhóm Where

Định nghĩa:

addGroup(op: 'and' | 'or', callback: (group: WhereGroupBuilder) => void): WhereFilterBuilder

Trả về: WhereFilterBuilder

Tham số:

Tham sốKiểuMô tả
op'and' | 'or'- Toán tử logic
callback(group: WhereGroupBuilder) => void- Hàm callback

update

Cập nhật điều kiện lọc có ID chỉ định

Định nghĩa:

update(id: string, callback: (node: WhereFilterNodeBuilder) => void): WhereFilterBuilder

Trả về: WhereFilterBuilder

Tham số:

Tham sốKiểuMô tả
idstring- ID điều kiện lọc
callback(node: WhereFilterNodeBuilder) => void- Hàm callback

updateGroup

Cập nhật nhóm có ID chỉ định

Định nghĩa:

updateGroup(id: string, callback: (group: WhereGroupBuilder) => void): WhereFilterBuilder

Trả về: WhereFilterBuilder

Tham số:

Tham sốKiểuMô tả
idstring- ID nhóm
callback(group: WhereGroupBuilder) => void- Hàm callback

remove

Xóa điều kiện có ID chỉ định hoặc mục tại index chỉ định

Định nghĩa:

remove(idOrIndex: string | number): WhereFilterBuilder

Trả về: WhereFilterBuilder

Tham số:

Tham sốKiểuMô tả
idOrIndexstring | number- ID hoặc index

find

Tìm điều kiện đầu tiên (lọc hoặc nhóm) theo callback, hành vi giống Array.find

Định nghĩa:

find(predicate: (entry: WhereFilterNodeBuilder | WhereGroupBuilder, index: number) => boolean): WhereFilterNodeBuilder | WhereGroupBuilder | undefined

Trả về: WhereFilterNodeBuilder \| WhereGroupBuilder \| undefined

Tham số:

Tham sốKiểuMô tả
predicate(entry: WhereFilterNodeBuilder | WhereGroupBuilder, index: number) => boolean- Điều kiện tìm kiếm

clear

Xóa tất cả điều kiện lọc Where

Định nghĩa:

clear()

toJSON

Xuất cấu hình lọc Where đầy đủ

Định nghĩa:

toJSON(): VBIWhereGroup

Trả về: VBIWhereGroup

observe

Lắng nghe thay đổi điều kiện lọc và trả về hàm hủy lắng nghe

Định nghĩa:

observe(callback: ObserveDeepCallback): () => void

Trả về: () => void

Tham số:

Tham sốKiểuMô tả
callbackObserveDeepCallback- Hàm callback

static isGroup

Xác định có phải node nhóm hay không

Định nghĩa:

static isGroup(yMap: Y.Map<any>): boolean

Trả về: boolean

Tham số:

Tham sốKiểuMô tả
yMapY.Map-

static isNode

Xác định có phải node lá hay không

Định nghĩa:

static isNode(yMap: Y.Map<any>): boolean

Trả về: boolean

Tham số:

Tham sốKiểuMô tả
yMapY.Map-