Defined in lib/dist/src/collection.d.ts:18
Constructors
constructor
new ( store: Store , server: string , params: CollectionParams , noFetch?: boolean ) : Collection
Parameters
server: string
Optional noFetch: boolean
Defined in lib/dist/src/collection.d.ts:26
Properties
Readonly __internal
Defined in lib/dist/src/collection.d.ts:19 Private _total _total: any
Defined in lib/dist/src/collection.d.ts:24 Private _wait _wait: any
Defined in lib/dist/src/collection.d.ts:25 Private build build: any
Defined in lib/dist/src/collection.d.ts:38 Private fetch fetch: any
Defined in lib/dist/src/collection.d.ts:39 Private pages pages: any
Defined in lib/dist/src/collection.d.ts:21 Private params params: any
Defined in lib/dist/src/collection.d.ts:23 Private server server: any
Defined in lib/dist/src/collection.d.ts:22 Private store store: any
Defined in lib/dist/src/collection.d.ts:20
Accessors
page
get pageSize( ) : number
Returns number
Defined in lib/dist/src/collection.d.ts:31 property
get property( ) : undefined | string
Returns undefined | string
Defined in lib/dist/src/collection.d.ts:27 sort
get sortBy( ) : undefined | string
Returns undefined | string
Defined in lib/dist/src/collection.d.ts:29 sort
get sortDesc( ) : boolean
Returns boolean
Defined in lib/dist/src/collection.d.ts:30 total
get totalMembers( ) : number
Returns number
Defined in lib/dist/src/collection.d.ts:32 value
get value( ) : undefined | string
Returns undefined | string
Defined in lib/dist/src/collection.d.ts:28
Methods
clear
clear( ) : void
Returns void
Defined in lib/dist/src/collection.d.ts:35 clone
clone( ) : Collection
Defined in lib/dist/src/collection.d.ts:37 get
get( index: number ) : Promise < string >
Returns Promise < string >
Defined in lib/dist/src/collection.d.ts:34 refresh
refresh( ) : Promise < void >
Returns Promise < void >
Defined in lib/dist/src/collection.d.ts:36 wait
wait( ) : Promise < void >
Returns Promise < void >
Defined in lib/dist/src/collection.d.ts:33
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
invalidatemethod to force a refresh.