Class: AspectQueryExecutor

Returns

string

aspectTypeName

aspectTypeName: object

aspectTypeName.map()

map: (model, ctx) => string | undefined

Parameters

model

ctx

Returns

string | undefined

aspectTypeName.requires

requires: readonly ["aspectTypes"]

assetDescription

assetDescription: object

assetDescription.map()

map: (model, ctx) => string | null | undefined

Parameters

model

ctx

Returns

string | null | undefined

assetDescription.requires

requires: readonly ["assets"]

assetFullName

assetFullName: object

assetFullName.index

index: object

assetFullName.index.kind

kind: "localField"

assetFullName.index.name

name: string = 'selectByPath'

assetFullName.map()

map: (model) => string

Parameters

model

Returns

string

assetId

assetId: object

assetId.index

index: object

assetId.index.kind

kind: "localField"

assetId.index.name

name: string = 'selectByAssetId'

assetId.map()

map: (model) => string

Parameters

model

Returns

string

assetTypeId

assetTypeId: object

assetTypeId.index

index: object

assetTypeId.index.kind

kind: "derived"

assetTypeId.index.multi

multi: boolean = true

assetTypeId.map()

map: (model, ctx) => string[]

Parameters

model

ctx

Returns

string[]

assetTypeId.multi

multi: boolean = true

assetTypeId.requires

requires: readonly ["assets"]

assetTypeName

assetTypeName: object

assetTypeName.map()

map: (model, ctx) => string[]

Parameters

model

ctx

Returns

string[]

assetTypeName.multi

multi: boolean = true

assetTypeName.requires

requires: readonly ["assets", "assetTypes"]

createdAt()

createdAt: (model) => Date

Parameters

model

Returns

Date

customId()

customId: (model) => string | null | undefined

Parameters

model

Returns

string | null | undefined

hasTag()

hasTag: (model) => boolean

Parameters

model

Returns

boolean

id

id: object

id.index

index: object

id.index.kind

kind: "localId"

id.map()

map: (model) => string

Parameters

model

Returns

string

name()

name: (model) => string

Parameters

model

Returns

string

ownerId()

ownerId: (model) => string | null | undefined

Parameters

model

Returns

string | null | undefined

ownerKind()

ownerKind: (model) => "Group" | "User" | "Unknown" | "API" | "System"

Parameters

model

Returns

"Group" | "User" | "Unknown" | "API" | "System"

tagDisplayName

tagDisplayName: object

tagDisplayName.map()

map: (_model) => undefined

Parameters

_model

Returns

undefined

tagDisplayName.supported

supported: boolean = false

tagId

tagId: object

tagId.map()

map: (model) => string[]

Parameters

model

Returns

string[]

tagId.multi

multi: boolean = true

updatedAt()

updatedAt: (model) => Date

Parameters

model

Returns

Date

Overrides

AbstractQueryExecutor.mapper

Methods

apply()

apply(rows, ctx?): Aspect[]

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:208

Single-call pipeline: filter → sort → paginate. Most consumers should use this; callers that need the unpaginated total should use applyWithCount instead.

Parameters

rows

readonly Aspect[]

ctx?

Returns

Inherited from

AbstractQueryExecutor.apply

applyWithCount()

applyWithCount(rows, ctx?): object

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:213

Like apply, but also returns the post-filter / pre-pagination row count. Useful for paged grids that show a total record badge.

Parameters

rows

readonly Aspect[]

ctx?

Returns

object

items

items: Aspect[]

totalCount

totalCount: number

Inherited from

AbstractQueryExecutor.applyWithCount

canExecute()

canExecute(): CanExecuteResult<AspectQueryFilterKeys, Aspect_RequiredSection>

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:148

Inspect the expression tree and report any keys/operators the executor cannot evaluate in-memory. Callers can use this to fall back to an API round-trip instead of subscribing to a selector that will silently return no rows.

Returns

CanExecuteResult<AspectQueryFilterKeys, Aspect_RequiredSection>

Inherited from

AbstractQueryExecutor.canExecute

eval_contains()

protected eval_contains(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:235

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_contains

eval_default()

protected eval_default(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:237

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_default

eval_endsWith()

protected eval_endsWith(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:233

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_endsWith

eval_equals()

protected eval_equals(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:225

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_equals

eval_greaterThan()

protected eval_greaterThan(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:227

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_greaterThan

eval_greaterThanOrEqual()

protected eval_greaterThanOrEqual(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:229

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_greaterThanOrEqual

eval_lessThan()

protected eval_lessThan(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:228

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_lessThan

eval_lessThanOrEqual()

protected eval_lessThanOrEqual(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:230

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_lessThanOrEqual

eval_notContains()

protected eval_notContains(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:236

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_notContains

eval_notEndsWith()

protected eval_notEndsWith(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:234

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_notEndsWith

eval_notEquals()

protected eval_notEquals(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:226

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_notEquals

eval_notStartsWith()

protected eval_notStartsWith(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:232

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_notStartsWith

eval_startsWith()

protected eval_startsWith(val, value): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:231

Parameters

val

any

value

string | number | boolean

Returns

boolean

Inherited from

AbstractQueryExecutor.eval_startsWith

filter()

filter(rows, ctx?): Aspect[]

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:188

Filter rows keeping only those that satisfy the executable expression. Equivalent to rows.filter(r => this.match(r, ctx)) but collocated with sort / paginate / apply for symmetry.

Parameters

rows

readonly Aspect[]

ctx?

Returns

Inherited from

AbstractQueryExecutor.filter

filterResidual()

filterResidual(rows, residualGroup, ctx?): Aspect[]

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:182

Filter rows against the residual AST returned by planBaseSet(). When the group has no leaves left, returns the input unchanged (copied) — the index intersection is already authoritative.

Parameters

rows

readonly Aspect[]

residualGroup

ExecutableGroup<AspectQueryFilterKeys>

ctx?

Returns

Inherited from

AbstractQueryExecutor.filterResidual

mapValue()

protected mapValue(entry, expression_key, ctx?): unknown

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:224

Extract the value from the entry based on the expression key.

Parameters

entry

The model entry to extract the value from.

expression_key

AspectQueryFilterKeys

the key of the expression to map.

ctx?

optional context forwarded to the mapper.

Returns

unknown

Inherited from

AbstractQueryExecutor.mapValue

match()

match(entry, ctx?): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:141

Evaluate the query against entry. The optional ctx is forwarded to every mapper invocation, enabling cross-model joins.

Parameters

entry

ctx?

Returns

boolean

Inherited from

AbstractQueryExecutor.match

matchGroup()

matchGroup(entry, group, ctx?): boolean

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:176

Same as match, but evaluates the supplied group instead of the top-level expression. Used by selectors to filter the narrowed base set against the residual AST returned by planBaseSet(). Returns true when the residual group has no leaves left to evaluate.

Parameters

entry

group

ExecutableGroup<AspectQueryFilterKeys>

ctx?

Returns

boolean

Inherited from

AbstractQueryExecutor.matchGroup

paginate()

paginate(rows): Aspect[]

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:202

Apply the { skip, take } window from the executable expression. take === null means “no limit” → returns the input slice (copy).

Parameters

rows

readonly Aspect[]

Returns

Inherited from

AbstractQueryExecutor.paginate

planBaseSet()

planBaseSet(): BaseSetPlan<AspectQueryFilterKeys>

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:169

Walk the root expression group and extract every top-level leaf whose mapper carries an index hint and uses an index-eligible operator (Equal for single-valued mappers, Equal / Contains for multi). The remaining (residual) AST is what the executor still needs to evaluate row-by-row after the section narrowed the base set.

Behaviour & guarantees:

Only extracts when the root group’s operator is And. Or roots cannot be safely narrowed without re-introducing rows excluded by other branches.
Nested groups are never inlined — they stay in residualGroup as full sub-trees and the executor evaluates them as usual.
When every leaf at the root is consumed and there are no nested groups, residualGroup is an empty AND-group (tautologically true). Callers may use hasResidualFilter as a hint to skip the per-row filter pass entirely.
When no leaf is consumed, callers should fall back to the existing apply(selectAll()) path unchanged.

Returns

BaseSetPlan<AspectQueryFilterKeys>

Inherited from

AbstractQueryExecutor.planBaseSet

sort()

sort(rows, ctx?): Aspect[]

Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.executor.d.ts:197

Stable, multi-key sort driven by expression.orderBy. Reuses the mapper to resolve values (multi-valued mappers compare by their first element). Null-handling: nulls last for ascending, nulls first for descending. Clauses whose mapper is missing/supported:false are silently skipped — callers should pre-check with canExecute() when the order matters for correctness.

Parameters

rows

readonly Aspect[]

ctx?

Returns