Skip to content

Commit a5c501a

Browse files
committed
docs(kitsu): add JSON:API query parameters to Quick Start
1 parent b6ca7b2 commit a5c501a

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

packages/kitsu/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu/MIGRATING.md>Migration guide</a> for v9 and previous major releases</p>
3030

31-
#
31+
#
3232

3333
## Features
3434

@@ -155,6 +155,22 @@ api.update('post', {
155155

156156
// Deleting resources
157157
api.remove('post', 1)
158+
159+
// JSON:API parameters
160+
api.get('users', {
161+
include: 'followers,waifu.character',
162+
fields: {
163+
users: 'slug,followers,waifu'
164+
}
165+
filter: {
166+
slug: 'wopian'
167+
}
168+
sort: '-id',
169+
page: {
170+
limit: 5,
171+
offset: 0
172+
}
173+
})
158174
```
159175

160176
[More Examples]

0 commit comments

Comments
 (0)