Class Store<RecordType>

Generic data store used by components

Type Parameters

RecordType = StoreRecord

Hierarchy

Collection<RecordType>
- Store
  - DataSourceStore

Index

Constructors

constructor

new Store<RecordType>(items?): Store<RecordType>
Type Parameters
- RecordType = StoreRecord
Parameters
- items: RecordType[] = []
Returns Store<RecordType>
Inherited from Collection.constructor
- Defined in util/Collection.ts:78

Properties

`Private` _loaded

_loaded: boolean = false

`Private` _loading

_loading: boolean = false

`Readonly` items

items: RecordType[]

sort

sort: Comparator[] = []

Sort the data on field and direction

Accessors

data

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

loaded

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

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

loading

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

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

Methods

[iterator]

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

add

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

clear

clear(): Store<RecordType>
Clears all items

Returns Store<RecordType>
Inherited from Collection.clear
- Defined in data/Store.ts:131

count

count(): number
Count the number of items

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

filter

filter(predicate): RecordType[]
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: RecordType
      
      index: number
      
      obj: RecordType[]
      
      Returns unknown
Returns RecordType[]
CollectionItem | undefined
Inherited from Collection.filter
- Defined in util/Collection.ts:267

find

find(predicate): undefined | RecordType
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: RecordType
      
      index: number
      
      obj: RecordType[]
      
      Returns unknown
Returns undefined | RecordType
CollectionItem | undefined
Inherited from Collection.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: RecordType
      
      index: number
      
      obj: RecordType[]
      
      Returns unknown
Returns number
Inherited from Collection.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, RecordType>[K]>
Returns boolean
Inherited from Collection.fire
- Defined in data/Store.ts:61

first

first(): undefined | RecordType
Return first item

Returns undefined | RecordType
Inherited from Collection.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: RecordType
      
      index: number
      
      array: RecordType[]
      
      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 Collection.forEach
- Defined in util/Collection.ts:236

get

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

getArray

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

has

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

hasNext

hasNext(): boolean
Returns boolean
- Defined in data/Store.ts:183

hasPrevious

hasPrevious(): boolean
Returns boolean
- Defined in data/Store.ts:187

indexOf

indexOf(item): number
Find the index of an item. Returns -1 if not found.
Parameters
- item: RecordType
Returns number
Inherited from Collection.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: RecordType[]
Returns number
Inherited from Collection.insert
- Defined in util/Collection.ts:114

`Protected` internalLoad

internalLoad(append): Promise<RecordType[]>
Protected
Returns the loaded records. If append is true it only returns the new records. Override this function for new store types.
Parameters
- append: boolean
Returns Promise<RecordType[]>
- Defined in data/Store.ts:143

last

last(): undefined | RecordType
return the last item

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

load

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

loadData

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

loadNext

loadNext(append?): Promise<RecordType[]>
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<RecordType[]>
- Defined in data/Store.ts:171

loadPrevious

loadPrevious(): Promise<RecordType[]>
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<RecordType[]>
- Defined in data/Store.ts:179

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<Store<RecordType>, RecordType>>[K]
- Optional options: ObservableListenerOpts
Returns L
Inherited from Collection.on
- Defined in data/Store.ts:59

`Protected` onFirstListenerAdded

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

`Protected` relayEvent

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

reload

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

Returns Promise<RecordType[]>
- Defined in data/Store.ts:126

remove

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

removeAt

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

replace

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

un

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

Class Store<RecordType>

Type Parameters

RecordType = StoreRecord

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

RecordType = StoreRecord

Parameters

items: RecordType[] = []

Returns Store<RecordType>

Properties

Private _loaded

Private _loading

Readonly items

sort

Accessors

data

Returns RecordType[]

Parameters

records: RecordType[]

Returns void

loaded

Returns boolean

loading

Returns boolean

Methods

[iterator]

Returns Iterator<RecordType, any, undefined>

add

Parameters

Rest ...items: RecordType[]

Returns number

clear

Returns Store<RecordType>

count

Returns number

filter

Parameters

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

Parameters

value: RecordType

index: number

obj: RecordType[]

Returns unknown

Returns RecordType[]

find

Parameters

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

Parameters

value: RecordType

index: number

obj: RecordType[]

Returns unknown

Returns undefined | RecordType

findIndex

Parameters

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

Parameters

value: RecordType

index: number

obj: RecordType[]

Returns unknown

Returns number

fire

Type Parameters

K extends keyof StoreEventMap<this, RecordType>

Parameters

eventName: K

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

Returns boolean

first

Returns undefined | RecordType

forEach

Parameters

`Private` _loaded

`Private` _loading

`Readonly` items

`Rest` ...items: RecordType[]

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

`Optional` thisArg: any

`Rest` ...items: RecordType[]

`Protected` internalLoad

`Optional` options: ObservableListenerOpts

`Protected` onFirstListenerAdded

`Protected` relayEvent