Class DataSourceStore<DataSource, StoreRecord>

DataSourceStore class

Uses an {@see AbstractDataSource} to present data in the view.

Type Parameters

DataSource extends AbstractDataSource = AbstractDataSource
StoreRecord = dataSourceEntityType<DataSource>

Hierarchy

Store<StoreRecord>
- DataSourceStore

Index

Constructors

constructor

new DataSourceStore<DataSource, StoreRecord>(dataSource): DataSourceStore<DataSource, StoreRecord>
Type Parameters
- DataSource extends AbstractDataSource<DefaultEntity> = AbstractDataSource<DefaultEntity>
- StoreRecord = dataSourceEntityType<DataSource>
Parameters
- dataSource: DataSource
Returns DataSourceStore<DataSource, StoreRecord>
Overrides Store.constructor
- Defined in data/DataSourceStore.ts:55

Properties

buildRecord

buildRecord: RecordBuilder<dataSourceEntityType<DataSource>, StoreRecord> = ...

Builds record from entity

Param

dataSource

dataSource: DataSource

`Private` filters

filters: Record<string, any> = {}

hasMore

hasMore: boolean = false

`Readonly` items

items: StoreRecord[]

monitorChanges

monitorChanges: boolean = true

Reload when the datasource changes

queryParams

queryParams: Omit<QueryParams, "sort"> = {}

`Optional` relations

relations?: Partial<Record<keyof DefaultEntity, {
dataSource: AbstractDataSource<DefaultEntity>;
path: string;
}>>

sort

sort: Comparator[] = []

Sort the data on field and direction

Accessors

data

get data(): RecordType[]
Returns RecordType[]
Inherited from Store.data
- Defined in data/Store.ts:119
set data(records): void
Parameters
- records: RecordType[]
Returns void
Inherited from Store.data
- Defined in data/Store.ts:115

loaded

get loaded(): boolean
True when data has been loaded at least once

Returns boolean
Inherited from Store.loaded
- Defined in data/Store.ts:99

loading

get loading(): boolean
True when the store is loading

Returns boolean
Inherited from Store.loading
- Defined in data/Store.ts:92

Methods

[iterator]

[iterator](): Iterator<StoreRecord, any, undefined>
Returns Iterator<StoreRecord, any, undefined>
Inherited from Store.[iterator]
- Defined in util/Collection.ts:83

add

add(...items): number
Add items at the end
Parameters
- Rest ...items: StoreRecord[]
Returns number
the index of the last added item
Inherited from Store.add
- Defined in util/Collection.ts:92

addScrollLoader

addScrollLoader(el): (() => void)
Load more data when this element is scrolled down
Parameters
- el: HTMLElement
Returns (() => void)
- - (): void
  - Returns void
- Defined in data/DataSourceStore.ts:171

clear

clear(): DataSourceStore<DataSource, StoreRecord>
Clears all items

Returns DataSourceStore<DataSource, StoreRecord>
Inherited from Store.clear
- Defined in data/Store.ts:131

clearFilter

clearFilter(...names): void
Parameters
- Rest ...names: string[]
Returns void
- Defined in data/DataSourceStore.ts:234

count

count(): number
Count the number of items

Returns number
Inherited from Store.count
- Defined in util/Collection.ts:207

`Private` fetchRelations

fetchRelations(records): Promise<dataSourceEntityType<DataSource>[]>
Parameters
- records: dataSourceEntityType<DataSource>[]
Returns Promise<dataSourceEntityType<DataSource>[]>
- Defined in data/DataSourceStore.ts:105

filter

filter(predicate): StoreRecord[]
The filter() method creates a new array with all elements that pass the test implemented by the provided function.
Parameters
- predicate: ((value, index, obj) => unknown)
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (value, index, obj): unknown
    - Parameters
      
      value: StoreRecord
      
      index: number
      
      obj: StoreRecord[]
      
      Returns unknown
Returns StoreRecord[]
CollectionItem | undefined
Inherited from Store.filter
- Defined in util/Collection.ts:267

find

find(predicate): undefined | StoreRecord
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Parameters
- predicate: ((value, index, obj) => unknown)
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (value, index, obj): unknown
    - Parameters
      
      value: StoreRecord
      
      index: number
      
      obj: StoreRecord[]
      
      Returns unknown
Returns undefined | StoreRecord
CollectionItem | undefined
Inherited from Store.find
- Defined in util/Collection.ts:254

findIndex

findIndex(predicate): number
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
- predicate: ((value, index, obj) => unknown)
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value, index, obj): unknown
    - Parameters
      
      value: StoreRecord
      
      index: number
      
      obj: StoreRecord[]
      
      Returns unknown
Returns number
Inherited from Store.findIndex
- Defined in util/Collection.ts:287

fire

fire<K>(eventName, ...args): boolean
Fire an event

When a listener returns false this function will return false too.
Type Parameters
- K extends keyof StoreEventMap<this, RecordType>
Parameters
- eventName: K
- Rest ...args: Parameters<StoreEventMap<any, StoreRecord>[K]>
Returns boolean
Inherited from Store.fire
- Defined in data/Store.ts:61

first

first(): undefined | StoreRecord
Return first item

Returns undefined | StoreRecord
Inherited from Store.first
- Defined in util/Collection.ts:147

forEach

forEach(callbackfn, thisArg?): void
Performs the specified action for each element in an array.
Parameters
- callbackfn: ((value, index, array) => void)
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value, index, array): void
    - Parameters
      
      value: StoreRecord
      
      index: number
      
      array: StoreRecord[]
      
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void
Inherited from Store.forEach
- Defined in util/Collection.ts:236

get

get(index): undefined | StoreRecord
Get an item at the given index
Parameters
- index: number
Returns undefined | StoreRecord
Inherited from Store.get
- Defined in util/Collection.ts:140

getArray

getArray(): StoreRecord[]
Returns StoreRecord[]
Inherited from Store.getArray
- Defined in util/Collection.ts:240

getFilter

getFilter(name): any
Parameters
- name: string
Returns any
- Defined in data/DataSourceStore.ts:238

has

has(item): boolean
Check if the given item is present
Parameters
- item: StoreRecord
Returns boolean
Inherited from Store.has
- Defined in util/Collection.ts:276

hasNext

hasNext(): boolean
Returns boolean
Overrides Store.hasNext
- Defined in data/DataSourceStore.ts:158

hasPrevious

hasPrevious(): boolean
Returns boolean
Overrides Store.hasPrevious
- Defined in data/DataSourceStore.ts:162

indexOf

indexOf(item): number
Find the index of an item. Returns -1 if not found.
Parameters
- item: StoreRecord
Returns number
Inherited from Store.indexOf
- Defined in util/Collection.ts:162

insert

insert(index, ...items): number
Insert items at the given index
Parameters
- index: number
  
  Use negative indexes to insert from the end. For example -1 inserts before the last item.
- Rest ...items: StoreRecord[]
Returns number
Inherited from Store.insert
- Defined in util/Collection.ts:114

`Protected` internalLoad

internalLoad(append?): Promise<Awaited<StoreRecord>[]>
Returns the loaded records. If append is true it only returns the new records. Override this function for new store types.
Parameters
- append: boolean = false
Returns Promise<Awaited<StoreRecord>[]>
Overrides Store.internalLoad
- Defined in data/DataSourceStore.ts:75

last

last(): undefined | StoreRecord
return the last item

Returns undefined | StoreRecord
Inherited from Store.last
- Defined in util/Collection.ts:154

load

load(append?): Promise<StoreRecord[]>
Loads the data from source into the store
Parameters
- append: boolean = false
Returns Promise<StoreRecord[]>
Inherited from Store.load
- Defined in data/Store.ts:153

loadData

loadData(records, append?): void
Load a set of records
Parameters
- records: StoreRecord[]
- append: boolean = true
Returns void
Inherited from Store.loadData
- Defined in data/Store.ts:109

loadNext

loadNext(append?): Promise<StoreRecord[]>
Load the next set of records when paging. Doesn't do anything in the array store but can be implemented in async stores.
Parameters
- append: boolean = false
Returns Promise<StoreRecord[]>
Overrides Store.loadNext
- Defined in data/DataSourceStore.ts:136

loadPrevious

loadPrevious(): Promise<StoreRecord[]>
Load the next set of records when paging. Doesn't do anything in the array store but can be implemented in async stores.

Returns Promise<StoreRecord[]>
Overrides Store.loadPrevious
- Defined in data/DataSourceStore.ts:147

on

on<K, L>(eventName, listener, options?): L
Add a listener
Type Parameters
- K extends keyof StoreEventMap<this, RecordType>
- L extends Listener
Parameters
- eventName: K
- listener: Partial<StoreEventMap<DataSourceStore<DataSource, StoreRecord>, StoreRecord>>[K]
- Optional options: ObservableListenerOpts
Returns L
Inherited from Store.on
- Defined in data/Store.ts:59

`Protected` onChange

onChange(DataSource, changes): Promise<void>
Protected
Reloads the store when the datasource changes
Parameters
- DataSource: DataSource
- changes: Changes
Returns Promise<void>
- Defined in data/DataSourceStore.ts:68

`Protected` onFirstListenerAdded

onFirstListenerAdded(eventName): void
Protected
Override this function to lazily initialize events
Parameters
- eventName: string
Returns void
Inherited from Store.onFirstListenerAdded
- Defined in component/Observable.ts:133

patchFilter

patchFilter(ref, filter): DataSourceStore<DataSource, StoreRecord>
Parameters
- ref: string
- filter: any
Returns DataSourceStore<DataSource, StoreRecord>
- Defined in data/DataSourceStore.ts:195

`Protected` relayEvent

relayEvent(comp, type): void
Parameters
- comp: Observable
- type: any
Returns void
Inherited from Store.relayEvent
- Defined in component/Observable.ts:199

reload

reload(): Promise<StoreRecord[]>
Reload the data from the source

Returns Promise<StoreRecord[]>
Overrides Store.reload
- Defined in data/DataSourceStore.ts:131

remove

remove(...items): void
Remove items
Parameters
- Rest ...items: StoreRecord[]
Returns void
Inherited from Store.remove
- Defined in util/Collection.ts:169

removeAt

removeAt(index): boolean
Remove an item
Parameters
- index: number
  
  Item index
Returns boolean
Inherited from Store.removeAt
- Defined in util/Collection.ts:185

replace

replace(...items): void
Replace the collection with an array
Parameters
- Rest ...items: StoreRecord[]
Returns void
Inherited from Store.replace
- Defined in util/Collection.ts:227

setFilter

setFilter(ref, filter): DataSourceStore<DataSource, StoreRecord>
Parameters
- ref: string
- filter: any
Returns DataSourceStore<DataSource, StoreRecord>
- Defined in data/DataSourceStore.ts:203

un

un<K>(eventName, listener): boolean
Remove listener
Type Parameters
- K extends keyof CollectionEventMap<this, CollectionItem>
Parameters
- eventName: K
- listener: Partial<CollectionEventMap<DataSourceStore<DataSource, StoreRecord>, StoreRecord>>[K]
Returns boolean
Inherited from Store.un
- Defined in util/Collection.ts:66

Class DataSourceStore<DataSource, StoreRecord>

Type Parameters

DataSource extends AbstractDataSource = AbstractDataSource

StoreRecord = dataSourceEntityType<DataSource>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

DataSource extends AbstractDataSource<DefaultEntity> = AbstractDataSource<DefaultEntity>

StoreRecord = dataSourceEntityType<DataSource>

Parameters

dataSource: DataSource

Returns DataSourceStore<DataSource, StoreRecord>

Properties

buildRecord

Param

dataSource

Private filters

hasMore

Readonly items

monitorChanges

queryParams

Optional relations

sort

Accessors

data

Returns RecordType[]

Parameters

records: RecordType[]

Returns void

loaded

Returns boolean

loading

Returns boolean

Methods

[iterator]

Returns Iterator<StoreRecord, any, undefined>

add

Parameters

Rest ...items: StoreRecord[]

Returns number

addScrollLoader

Parameters

el: HTMLElement

Returns (() => void)

Returns void

clear

Returns DataSourceStore<DataSource, StoreRecord>

clearFilter

Parameters

Rest ...names: string[]

Returns void

count

Returns number

Private fetchRelations

Parameters

records: dataSourceEntityType<DataSource>[]

Returns Promise<dataSourceEntityType<DataSource>[]>

filter

Parameters

predicate: ((value, index, obj) => unknown)

Parameters

value: StoreRecord

index: number

obj: StoreRecord[]

Returns unknown

Returns StoreRecord[]

find

Parameters

predicate: ((value, index, obj) => unknown)

Parameters

value: StoreRecord

index: number

obj: StoreRecord[]

Returns unknown

`Private` filters

`Readonly` items

`Optional` relations

`Rest` ...items: StoreRecord[]

`Rest` ...names: string[]

`Private` fetchRelations

`Rest` ...args: Parameters<StoreEventMap<any, StoreRecord>[K]>

`Optional` thisArg: any

`Rest` ...items: StoreRecord[]

`Protected` internalLoad