Class XtStoreProviderHelper

Helps handle metadata information about loaded items

Index

Constructors

Methods

applyFilters calculateGroupedByValues compareFunction insertInSortedList multiSortArray

Constructors

constructor

new XtStoreProviderHelper(): XtStoreProviderHelper
Returns XtStoreProviderHelper

Methods

`Static`applyFilters

applyFilters<T>(list: T[], ...criteria: XtStoreCriteria<T>[]): T[]
In case the provider source doesn't support search criteria, they can be applied here
Type Parameters
- T
Parameters
- list: T[]
- ...criteria: XtStoreCriteria<T>[]
Returns T[]
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider-helper.ts:22

`Static`calculateGroupedByValues

calculateGroupedByValues<T>(
    name: string,
    values: T[],
    groupBy: XtGroupBy<T>,
): DontCodeStoreGroupedByEntities<T> | undefined
Calculates sum, avg, min or max values per group
Type Parameters
- T
Parameters
- name: string
  The entity name
- values: T[]
  The raw entity values
- groupBy: XtGroupBy<T>
  The grouping configuration
Returns DontCodeStoreGroupedByEntities<T> | undefined
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider-helper.ts:186

`Static`compareFunction

compareFunction<T>(sortOptions: XtSortBy<T>[]): (a: T, b: T) => number
Returns a compare function based on the sort options given
Type Parameters
- T
Parameters
- sortOptions: XtSortBy<T>[]
Returns (a: T, b: T) => number
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider-helper.ts:164

`Static`insertInSortedList

insertInSortedList<T>(toInsert: T, list: T[], sortOptions?: XtSortBy<T>[]): T[]
Quickly insert an element in an already sorted list
Type Parameters
- T
Parameters
- toInsert: T
- list: T[]
- OptionalsortOptions: XtSortBy<T>[]
Returns T[]
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider-helper.ts:143

`Static`multiSortArray

multiSortArray<T>(toSort: T[], sortOptions?: XtSortBy<T>[]): T[]
Sort the array using the defined sort declarations across all properties.
Type Parameters
- T
Parameters
- toSort: T[]
- OptionalsortOptions: XtSortBy<T>[]
Returns T[]
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider-helper.ts:131