External module query

Index

Classes

Type aliases

FilterType

Variables

filterTypes

Functions

Type aliases

FilterType

FilterType: "boolean" | "containsString" | "dateRange" | "doubleRange" | "like" | "logOp" | "longEnum" | "longRange" | "stringEnum" | "string" | "stringMap" | "stringRange" | "null"

kind of Filter as defined by corresponding Java object model.

Variables

filterTypes

filterTypes: Array<string>

all known valid types of filters.

type: {string[]} of all known types of filters.

Functions

isFilter

isFilter(filter: any): boolean

- Defined in query/Filter.ts:87
checks if an object is a Filter.

Parameters
- filter: any
  
  object to check.
Returns boolean

whether filter is a filter.

isFilterType

isFilterType(type: any): boolean

- Defined in query/Filter.ts:70
checks if a given type value is a valid FilterType value.

Parameters
- type: any
  
  value to check.
Returns boolean

whether type value is valid.

jsonCompare

jsonCompare<T>(json: string, options?: JsonCompareOptions): JsonCompareFn<T>
jsonCompare<T>(json: string[], options?: JsonCompareOptions): JsonCompareFn<T>
jsonCompare<T>(sortOrder: SortOrder, options?: JsonCompareOptions): JsonCompareFn<T>

- Defined in query/SortOrderComparator.ts:61
compiles a JsonCompareFn from a given SortOrder.

Type parameters
- T
Parameters
- json: string
  
  of SortOrder being compiled.
- Optional options: JsonCompareOptions
Returns JsonCompareFn<T>

a JsonCompareFn function compatible to Array.sort().
- Defined in query/SortOrderComparator.ts:68
compiles a JsonCompareFn from a given SortOrder.

Type parameters
- T
Parameters
- json: string[]
  
  of SortOrder being compiled.
- Optional options: JsonCompareOptions
Returns JsonCompareFn<T>

a JsonCompareFn function compatible to Array.sort().
- Defined in query/SortOrderComparator.ts:75
compiles a JsonCompareFn from a given SortOrder.

Type parameters
- T
Parameters
- sortOrder: SortOrder
  
  being compiled.
- Optional options: JsonCompareOptions
Returns JsonCompareFn<T>

a JsonCompareFn function compatible to Array.sort().

jsonFilter

jsonFilter<T>(filter: Filter, options?: JsonFilterOptions): JsonFilterFn<T>

- Defined in query/JsonFilterVisitor.ts:62
compiles a JsonFilterFn from a given Filter tree.

Type parameters
- T
Parameters
- filter: Filter
  
  tree being compiled.
- Optional options: JsonFilterOptions
  
  customizing the matching, entirely optional.
Returns JsonFilterFn<T>

a JsonFilterFn function.

Generated using TypeDoc