Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.9 KB

CoverageCollectionPaging.md

File metadata and controls

34 lines (21 loc) · 1.9 KB

CoverageCollectionPaging objects

CoverageCollectionPaging properties

.total

If defined, the total number of coverages within the paged collection.

.next

If defined, an object with a single method load([options]) that when called returns a Promise object which succeeds with a CoverageCollection object corresponding to the next collection page. options is an optional object with an optional property eagerload: true.

Example

var coll = ...
if (coll.paging && coll.paging.next) {
  coll.paging.next.load().then(function (nextcoll) {
    // access coverages of next page
  })
)

.previous

If defined, an object with a single method load([options]) that when called returns a Promise object which succeeds with a CoverageCollection object corresponding to the previous collection page. options is an optional object with an optional property eagerload: true.

.first

If defined, an object with a single method load([options]) that when called returns a Promise object which succeeds with a CoverageCollection object corresponding to the first collection page. options is an optional object with an optional property eagerload: true.

.last

If defined, an object with a single method load([options]) that when called returns a Promise object which succeeds with a CoverageCollection object corresponding to the last collection page. options is an optional object with an optional property eagerload: true.