Skip to main content
Version: 4.5

Class: QueryHelper#

core.QueryHelper

Constructors#

constructor#

+ new QueryHelper(): QueryHelper

Returns: QueryHelper

Properties#

SUPPORTED_OPERATORS#

Readonly Static SUPPORTED_OPERATORS: string[]

Defined in: packages/core/src/utils/QueryHelper.ts:11

Methods#

getActiveFilters#

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

Parameters:#

NameType
entityNamestring
optionsboolean | string[] | Dictionary<boolean | Dictionary<any>>
filtersDictionary<FilterDef<any>>

Returns: FilterDef<any>[]

Defined in: packages/core/src/utils/QueryHelper.ts:165


inlinePrimaryKeyObjects#

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

Type parameters:#

NameType
TAnyEntity<T>

Parameters:#

NameType
whereDictionary<any>
metaEntityMetadata<T>
metadataMetadataStorage
key?string

Returns: boolean

Defined in: packages/core/src/utils/QueryHelper.ts:45


isFilterActive#

StaticisFilterActive(entityName: string, filterName: string, filter: FilterDef<any>, options: Dictionary<boolean | Dictionary<any>>): boolean

Parameters:#

NameType
entityNamestring
filterNamestring
filterFilterDef<any>
optionsDictionary<boolean | Dictionary<any>>

Returns: boolean

Defined in: packages/core/src/utils/QueryHelper.ts:186


isSupportedOperator#

Private StaticisSupportedOperator(key: string): boolean

Parameters:#

NameType
keystring

Returns: boolean

Defined in: packages/core/src/utils/QueryHelper.ts:240


processCustomType#

StaticprocessCustomType<T>(prop: EntityProperty<T>, cond: FilterQuery<T>, platform: Platform, key?: string, fromQuery?: boolean): FilterQuery<T>

Type parameters:#

Name
T

Parameters:#

NameType
propEntityProperty<T>
condFilterQuery<T>
platformPlatform
key?string
fromQuery?boolean

Returns: FilterQuery<T>

Defined in: packages/core/src/utils/QueryHelper.ts:198


processEntity#

Private StaticprocessEntity(entity: AnyEntity<any>, root?: boolean): any

Parameters:#

NameType
entityAnyEntity<any>
root?boolean

Returns: any

Defined in: packages/core/src/utils/QueryHelper.ts:218


processExpression#

Private StaticprocessExpression<T>(expr: string, value: T): Dictionary<T>

Type parameters:#

Name
T

Parameters:#

NameType
exprstring
valueT

Returns: Dictionary<T>

Defined in: packages/core/src/utils/QueryHelper.ts:228


processJsonCondition#

Private StaticprocessJsonCondition<T>(o: FilterQuery<T>, value: Dictionary<any>, path: string[], platform: Platform): FilterQuery<T>

Type parameters:#

Name
T

Parameters:#

NameType
oFilterQuery<T>
valueDictionary<any>
pathstring[]
platformPlatform

Returns: FilterQuery<T>

Defined in: packages/core/src/utils/QueryHelper.ts:244


processObjectParams#

StaticprocessObjectParams(params?: Dictionary<any>): any

Parameters:#

NameType
paramsDictionary<any>

Returns: any

Defined in: packages/core/src/utils/QueryHelper.ts:37


processParams#

StaticprocessParams(params: any, root?: boolean): any

Parameters:#

NameType
paramsany
root?boolean

Returns: any

Defined in: packages/core/src/utils/QueryHelper.ts:13


processWhere#

StaticprocessWhere<T>(where: FilterQuery<T>, entityName: string, metadata: MetadataStorage, platform: Platform, convertCustomTypes?: boolean, root?: boolean): FilterQuery<T>

Type parameters:#

NameType
TAnyEntity<T>

Parameters:#

NameTypeDefault value
whereFilterQuery<T>-
entityNamestring-
metadataMetadataStorage-
platformPlatform-
convertCustomTypesbooleantrue
rootbooleantrue

Returns: FilterQuery<T>

Defined in: packages/core/src/utils/QueryHelper.ts:73

Last updated on by Renovate Bot