Hierarchy
- SyncContext
Hierarchy-Diagram
Index
Constructors
constructor
-
captures option values forming a GetQuery.
Parameters
-
Rest ...options: object[]
to merge.
Returns SyncContext
-
Properties
Private compareFn
when set, defines sorting of collection.
Private filterFn
when set, defines filtering of collection.
Private getQuery
relevant parameters for paging, filtering and sorting.
Private lastInsertionPoint
used to speed up insertion point when doing consecutive insertions into sorted ranges.
Private pageSize
limit of getQuery captured at construction time.
Methods
fetchMore
-
reads an additional page of data into the collection.
When async processing is done, a more attribute is set on the options object in case additional data might be available which can be loaded by calling this method again. Likewise an end attribute is set if the data is fully loaded.
Parameters
-
collection: Collection
to load data into.
-
Default value options: any = {}
such as pageSize to retrieve.
Returns any
promise of the load operation.
-
fetchNext
-
reads the next page of data into the collection.
Parameters
-
collection: Collection
-
Default value options: any = {}
such as pageSize to retrieve.
Returns any
promise of the load operation.
-
fetchPrev
-
reads the previous page of data into the collection.
Parameters
-
collection: Collection
-
Default value options: any = {}
such as pageSize to retrieve.
Returns any
promise of the load operation.
-
Private fetchRange
-
reads a page of data into the collection.
When async processing is done, a next/prev attribute is set on the options object in case additional pages might be available which can be loaded by calling this method again.
Parameters
-
collection: Collection
to load data into.
-
Default value options: any = {}
incl. offset and limit of page to retrieve.
Returns any
promise of the load operation.
-
filterAttributes
-
Type parameters
-
T
Parameters
-
attrs: T[]
-
Optional options: any
Returns T[]
-
Private insertionPoint
-
computes the insertion point of attributes into models sorted by compareFn.
This is used to compute the at-index of backbone.js add() method options when adding models to a sorted collection.
Parameters
-
attributes: any
being inserted.
-
models: Model[]
sorted by compareFn.
Returns number
insertion point.
-
Private insertionPointBinarySearch
-
performs a binary search for insertion point of attributes into models[start:end] sorted by compareFn.
Parameters
-
attributes: any
being inserted.
-
models: Model[]
sorted by compareFn.
-
start: number
inclusive index of search interval.
-
end: number
exclusive index of search interval.
Returns number
insertion point.
-
onMessage
-
receives change messages.
Change messages are communicated by the SyncStore indirectly triggering a sync:channel event. This happens regardless of whether the change originates local or remote. The context then alters the backbone data incorporating the change.
Parameters
-
store: Store
-
collection: Collection
-
msg: LiveDataMessage
Returns void
-
processAttributes
-
Type parameters
-
T
Parameters
-
attrs: T[]
-
Optional options: any
Returns T[]
-
rangeAttributes
-
Type parameters
-
T
Parameters
-
attrs: T[]
-
Optional options: any
Returns T[]
-
sortAttributes
-
Type parameters
-
T
Parameters
-
attrs: T[]
-
Optional options: any
Returns T[]
-
receives change messages and updates collections.