QueryHelper

Index

Constructors

• constructor

Properties

• SUPPORTED_OPERATORS

Methods

• findProperty
• getActiveFilters
• inlinePrimaryKeyObjects
• isFilterActive
• processCustomType
• processObjectParams
• processParams
• processWhere

Constructors

constructor

• new QueryHelper(): QueryHelper

• Returns QueryHelper

Properties

staticreadonlySUPPORTED_OPERATORS

SUPPORTED_OPERATORS: string[] = ...

Methods

staticfindProperty

• findProperty<T>(fieldName, options): undefined | EntityProperty<T, any>

• Type parameters

  • T

  Parameters

  • fieldName: string

  • options: ProcessWhereOptions<T>

  Returns undefined | EntityProperty<T, any>

staticgetActiveFilters

• getActiveFilters(entityName, options, filters): FilterDef[]

• Parameters

  • entityName: string

  • options: boolean | string[] | Dictionary<boolean | Dictionary>

  • filters: Dictionary<FilterDef>

  Returns FilterDef[]

staticinlinePrimaryKeyObjects

• inlinePrimaryKeyObjects<T>(where, meta, metadata, key): boolean

• Type parameters

  • T: object

  Parameters

  • where: Dictionary

  • meta: EntityMetadata<T>

  • metadata: MetadataStorage

  • optionalkey: string

  Returns boolean

staticisFilterActive

• isFilterActive(entityName, filterName, filter, options): boolean

• Parameters

  • entityName: string

  • filterName: string

  • filter: FilterDef

  • options: Dictionary<boolean | Dictionary>

  Returns boolean

staticprocessCustomType

• processCustomType<T>(prop, cond, platform, key, fromQuery): FilterQuery<T>

• Type parameters

  • T: object

  Parameters

  • prop: EntityProperty<T, any>

  • cond: FilterQuery<T>

  • platform: Platform

  • optionalkey: string

  • optionalfromQuery: boolean

  Returns FilterQuery<T>

staticprocessObjectParams

• processObjectParams<T>(params): T

• Type parameters

  • T: object

  Parameters

  • params: T = ...

  Returns T

staticprocessParams

• processParams(params): any

• Parameters

  • params: unknown

  Returns any

staticprocessWhere

• processWhere<T>(options): FilterQuery<T>

• Type parameters

  • T: object

  Parameters

  • options: ProcessWhereOptions<T>

  Returns FilterQuery<T>