Class Collection

A collection is a dynamic resource that queries the server for a list of resources that meet it's criteria. Checkout the docs for more information.

Keep in mind that the collection does currently not subscribe to changes in the store and will therefore not update if items are added or removed. Use the invalidate method to force a refresh.

Hierarchy

Collection

Index

Constructors

Properties

__internalObject _totalMembers _waitForReady pages params server store

Accessors

pageSize property sortBy sortDesc totalMembers value

Methods

buildSubject clearPages clone fetchPage getMemberWithIndex refresh waitForReady

Constructors

constructor

new Collection(store: Store, server: string, params: CollectionParams, noFetch?: boolean): Collection
Parameters
- store: Store
- server: string
- params: CollectionParams
- noFetch: boolean = false
Returns Collection
- Defined in lib/src/collection.ts:35

Properties

`Readonly` __internalObject

__internalObject: Collection = ...

`Private` _totalMembers

_totalMembers: number = 0

`Private` _waitForReady

_waitForReady: Promise<void>

`Private` pages

pages: Map<number, Resource<any>> = ...

`Private` params

params: CollectionParams

`Private` server

server: string

`Private` store

store: Store

Accessors

pageSize

get pageSize(): number
Returns number
- Defined in lib/src/collection.ts:68

property

get property(): undefined | string
Returns undefined | string
- Defined in lib/src/collection.ts:52

sortBy

get sortBy(): undefined | string
Returns undefined | string
- Defined in lib/src/collection.ts:60

sortDesc

get sortDesc(): boolean
Returns boolean
- Defined in lib/src/collection.ts:64

totalMembers

get totalMembers(): number
Returns number
- Defined in lib/src/collection.ts:72

value

get value(): undefined | string
Returns undefined | string
- Defined in lib/src/collection.ts:56

Methods

`Private` buildSubject

buildSubject(page: number): string
Parameters
- page: number
Returns string
- Defined in lib/src/collection.ts:120

clearPages

clearPages(): void
Returns void
- Defined in lib/src/collection.ts:100

clone

clone(): Collection
Returns Collection
- Defined in lib/src/collection.ts:111

`Private` fetchPage

fetchPage(page: number): Promise<void>
Parameters
- page: number
Returns Promise<void>
- Defined in lib/src/collection.ts:132

getMemberWithIndex

getMemberWithIndex(index: number): Promise<string>
Parameters
- index: number
Returns Promise<string>
- Defined in lib/src/collection.ts:80

refresh

refresh(): Promise<void>
Returns Promise<void>
- Defined in lib/src/collection.ts:104

waitForReady

waitForReady(): Promise<void>
Returns Promise<void>
- Defined in lib/src/collection.ts:76

Generated using TypeDoc