Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with JSON-API configuration #354

Merged
merged 1 commit into from
Jan 10, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,26 @@ and `ember-infinity` will be set up to parse the total number of pages from a JS
You can also prevent the `per_page` or `page` parameters from being sent by setting `perPageParam` or `pageParam` to `null`, respectively.
Moreover, if your backend passes the total number of records instead of total pages, then as it's replacement, set the `countParam`.

### Example JSON-API customization

```js
import Route from '@ember/routing/route';
import { inject } from '@ember/service';

export default Route.extend({
infinity: inject(),

model() {
return this.infinity.model('product', {
perPage: 20,
startingPage: 1,
perPageParam: 'page[size]',
pageParam: 'page[number]'
});
},
});
```

### Cursor-based pagination

If you are serving a continuously updating stream, it's helpful to keep track
Expand Down