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: string, options: ProcessWhereOptions<T>): undefined | EntityProperty<T, any>

• Type parameters

  • T

  Parameters

  • fieldName: string

  • options: ProcessWhereOptions<T>

  Returns undefined | EntityProperty<T, any>

staticgetActiveFilters

• getActiveFilters(entityName: string, options: boolean | string[] | Dictionary<boolean | Dictionary>, filters: Dictionary<FilterDef>): FilterDef[]

• Parameters

  • entityName: string

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

  • filters: Dictionary<FilterDef>

  Returns FilterDef[]

staticinlinePrimaryKeyObjects

• inlinePrimaryKeyObjects<T>(where: Dictionary, meta: EntityMetadata<T>, metadata: MetadataStorage, key?: string): boolean

• Type parameters

  • T: object

  Parameters

  • where: Dictionary

  • meta: EntityMetadata<T>

  • metadata: MetadataStorage

  • optionalkey: string

  Returns boolean

staticisFilterActive

• isFilterActive(entityName: string, filterName: string, filter: FilterDef, options: Dictionary<boolean | Dictionary>): boolean

• Parameters

  • entityName: string

  • filterName: string

  • filter: FilterDef

  • options: Dictionary<boolean | Dictionary>

  Returns boolean

staticprocessCustomType

• processCustomType<T>(prop: EntityProperty<T, any>, cond: FilterQuery<T>, platform: Platform, key?: string, fromQuery?: boolean): 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): T

• Type parameters

  • T: object

  Parameters

  • params: T = ...

  Returns T

staticprocessParams

• processParams(params: unknown): any

• Parameters

  • params: unknown

  Returns any

staticprocessWhere

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

• Type parameters

  • T: object

  Parameters

  • options: ProcessWhereOptions<T>

  Returns FilterQuery<T>