API Docs for: 0.25.0
Show:

PaginatedRouteMixin Class

Extends Ember.Mixin
Defined in: addon/mixins/paginated-route.js:8
Module: mixins
Parent Module: ember-osf

Route mixin to support fetching paginated results

Because this uses query parameters, it should be used in tandem with PaginatedControllerMixin

Item Index

Methods

Properties

Methods

apply

(
  • obj
)
private

Inherited from Ember.Mixin: packages/ember-metal/lib/mixin.js:555

Parameters:

Returns:

applied object

detect

(
  • obj
)
Boolean private

Inherited from Ember.Mixin: packages/ember-metal/lib/mixin.js:586

Parameters:

Returns:

Boolean:

queryForPage

(
  • modelName
  • routeParams
  • userParams
)
Promise

Defined in addon/mixins/paginated-route.js:43

Fetch a route-specified page of results from an external API

To use this argument, pass the params from the model hook as the first argument.

model(routeParams) {
  return this.queryForPage('user', routeParams);
}

Parameters:

  • modelName Object

    The name of the model to query in the store

  • routeParams Object

    Parameters dictionary available to the model hook; must be passed in manually

  • userParams Object

    Additional user-specified query parameters to further customize the query

Returns:

Promise:

reopen

(
  • arguments
)
private

Inherited from Ember.Mixin: packages/ember-metal/lib/mixin.js:518

Parameters:

Properties

pageParam

String

Defined in addon/mixins/paginated-route.js:27

Allow configuration of the backend URL parameter used for page #

Default: "page"

perPageParam

String

Defined in addon/mixins/paginated-route.js:35

Allow configuration of the backend URL parameter for number of results per page

Default: "page[size]"