Skip to content

Commit fe39500

Browse files
wopianwopian
committed
chore(release): update documentation
1 parent e1b988c commit fe39500

3 files changed

Lines changed: 90 additions & 57 deletions

File tree

‎packages/kitsu-core/README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ All code released under [MIT]
127127

128128
### deattribute
129129

130-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
130+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
131131

132132
Hoists attributes to be top-level
133133

@@ -171,7 +171,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
171171

172172
### deserialise
173173

174-
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
174+
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
175175

176176
Deserialises a JSON-API response
177177

@@ -223,7 +223,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
223223

224224
### error
225225

226-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
226+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
227227

228228
Uniform error handling for Axios, JSON:API and internal package errors. Mutated Error object is rethrown to the caller.
229229

@@ -260,7 +260,7 @@ error({
260260

261261
### filterIncludes
262262

263-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
263+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
264264

265265
Filters includes for the specific relationship requested
266266

@@ -299,7 +299,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl
299299

300300
### linkRelationships
301301

302-
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
302+
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
303303

304304
Links relationships to included data
305305

@@ -337,7 +337,7 @@ Returns **any** Parsed data
337337

338338
### query
339339

340-
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
340+
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
341341

342342
Constructs a URL query string for JSON:API parameters
343343

@@ -365,7 +365,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
365365

366366
### serialise
367367

368-
[packages/kitsu-core/src/serialise/index.js:210-221](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu-core/src/serialise/index.js#L210-L221 "Source code on GitHub")
368+
[packages/kitsu-core/src/serialise/index.js:210-221](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu-core/src/serialise/index.js#L210-L221 "Source code on GitHub")
369369

370370
Serialises an object into a JSON-API structure
371371

@@ -411,7 +411,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
411411

412412
### splitModel
413413

414-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
414+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
415415

416416
Split model name from the model's resource URL
417417

@@ -454,7 +454,7 @@ Returns **\[[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference
454454

455455
### camel
456456

457-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
457+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
458458

459459
Converts kebab-case and snake_case into camelCase
460460

@@ -482,7 +482,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
482482

483483
### kebab
484484

485-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
485+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
486486

487487
Converts camelCase into kebab-case
488488

@@ -500,7 +500,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
500500

501501
### snake
502502

503-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
503+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
504504

505505
Converts camelCase into snake_case
506506

‎packages/kitsu/README.md‎

Lines changed: 47 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ If you're working with [Kitsu.io]'s API, their [API docs][kitsu.io api docs] lis
224224

225225
### Kitsu
226226

227-
[packages/kitsu/src/index.js:31-482](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu/src/index.js#L31-L482 "Source code on GitHub")
227+
[packages/kitsu/src/index.js:31-503](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu/src/index.js#L31-L503 "Source code on GitHub")
228228

229229
Creates a new `kitsu` instance
230230

@@ -271,7 +271,7 @@ const api = new Kitsu({
271271

272272
#### plural
273273

274-
[packages/kitsu/src/index.js:53-54](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu/src/index.js#L53-L54 "Source code on GitHub")
274+
[packages/kitsu/src/index.js:53-54](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu/src/index.js#L53-L54 "Source code on GitHub")
275275

276276
- **See: <https://www.npmjs.com/package/pluralize> for documentation
277277
**
@@ -293,7 +293,7 @@ api.plural.plural('paper') //=> 'paper'
293293

294294
#### headers
295295

296-
[packages/kitsu/src/index.js:68-68](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu/src/index.js#L68-L68 "Source code on GitHub")
296+
[packages/kitsu/src/index.js:68-68](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu/src/index.js#L68-L68 "Source code on GitHub")
297297

298298
Get the current headers or add additional headers
299299

@@ -324,7 +324,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
324324

325325
#### interceptors
326326

327-
[packages/kitsu/src/index.js:113-113](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub")
327+
[packages/kitsu/src/index.js:113-113](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub")
328328

329329
- **See: <https://github.com/axios/axios#interceptors> for documentation
330330
**
@@ -375,7 +375,7 @@ api.interceptors.request.eject(myInterceptor)
375375

376376
#### get
377377

378-
[packages/kitsu/src/index.js:191-211](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu/src/index.js#L191-L211 "Source code on GitHub")
378+
[packages/kitsu/src/index.js:210-230](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu/src/index.js#L210-L230 "Source code on GitHub")
379379

380380
Fetch resources (alias `fetch`)
381381

@@ -404,11 +404,13 @@ Getting a resource with JSON:API parameters
404404

405405
```javascript
406406
api.get('users', {
407-
fields: {
408-
users: 'name,birthday'
409-
},
410-
filter: {
411-
name: 'wopian'
407+
params: {
408+
fields: {
409+
users: 'name,birthday'
410+
},
411+
filter: {
412+
name: 'wopian'
413+
}
412414
}
413415
})
414416
```
@@ -418,7 +420,9 @@ Getting a collection of resources with their relationships
418420

419421
```javascript
420422
api.get('anime', {
421-
include: 'categories'
423+
params: {
424+
include: 'categories'
425+
}
422426
})
423427
```
424428

@@ -427,7 +431,9 @@ Getting a single resource by ID (method one)
427431

428432
```javascript
429433
api.get('anime/2', {
430-
include: 'categories'
434+
params: {
435+
include: 'categories'
436+
}
431437
})
432438
```
433439

@@ -436,8 +442,10 @@ Getting a single resource by ID (method two)
436442

437443
```javascript
438444
api.get('anime', {
439-
include: 'categories',
440-
filter: { id: '2' }
445+
params: {
446+
include: 'categories',
447+
filter: { id: '2' }
448+
}
441449
})
442450
```
443451

@@ -448,6 +456,22 @@ Getting a resource's relationship data only
448456
api.get('anime/2/categories')
449457
```
450458

459+
Getting a resource with nested JSON:API filters (not supported by Kitsu.io's API)
460+
461+
462+
```javascript
463+
// resource?filter[x][y]=value
464+
api.get('resource', {
465+
params: {
466+
filter: {
467+
x: {
468+
y: 'value'
469+
}
470+
}
471+
}
472+
}
473+
```
474+
451475
Handling errors (async/await)
452476
453477
@@ -492,7 +516,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
492516
493517
#### patch
494518
495-
[packages/kitsu/src/index.js:246-273](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu/src/index.js#L246-L273 "Source code on GitHub")
519+
[packages/kitsu/src/index.js:265-292](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu/src/index.js#L265-L292 "Source code on GitHub")
496520
497521
Update a resource (alias `update`)
498522
@@ -557,7 +581,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
557581
558582
#### post
559583
560-
[packages/kitsu/src/index.js:303-328](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu/src/index.js#L303-L328 "Source code on GitHub")
584+
[packages/kitsu/src/index.js:322-347](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu/src/index.js#L322-L347 "Source code on GitHub")
561585
562586
Create a new resource (alias `create`)
563587
@@ -602,7 +626,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
602626
603627
#### delete
604628
605-
[packages/kitsu/src/index.js:345-378](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu/src/index.js#L345-L378 "Source code on GitHub")
629+
[packages/kitsu/src/index.js:364-397](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu/src/index.js#L364-L397 "Source code on GitHub")
606630
607631
Remove a resource (alias `remove`)
608632
@@ -634,7 +658,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
634658
635659
#### self
636660
637-
[packages/kitsu/src/index.js:399-408](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu/src/index.js#L399-L408 "Source code on GitHub")
661+
[packages/kitsu/src/index.js:420-429](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu/src/index.js#L420-L429 "Source code on GitHub")
638662
639663
Get the authenticated user's data
640664
@@ -660,8 +684,10 @@ Using JSON:API parameters
660684
661685
```javascript
662686
api.self({
663-
fields: {
664-
users: 'name,birthday'
687+
params: {
688+
fields: {
689+
users: 'name,birthday'
690+
}
665691
}
666692
})
667693
```
@@ -670,7 +696,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
670696
671697
#### request
672698
673-
[packages/kitsu/src/index.js:462-481](https://github.com/wopian/kitsu/blob/3f9f99672eb9c883bbccd5cad7a13c88bf0f7561/packages/kitsu/src/index.js#L462-L481 "Source code on GitHub")
699+
[packages/kitsu/src/index.js:483-502](https://github.com/wopian/kitsu/blob/e1b988cb961081f12309f5e881d63d123be7f4cf/packages/kitsu/src/index.js#L483-L502 "Source code on GitHub")
674700
675701
Send arbitrary requests
676702
@@ -751,17 +777,3 @@ api.request({
751777
```
752778
753779
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** JSON-parsed response
754-
755-
[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises
756-
757-
[More Examples]: https://github.com/wopian/kitsu/tree/master/packages/kitsu/example
758-
759-
[Kitsu.io]: https://kitsu.io
760-
761-
[kitsu.io api docs]: https://kitsu.docs.apiary.io
762-
763-
[CHANGELOG]: https://github.com/wopian/kitsu/blob/master/packages/kitsu/CHANGELOG.md
764-
765-
[CONTRIBUTING]: https://github.com/wopian/kitsu/blob/master/CONTRIBUTING.md
766-
767-
[MIT]: https://github.com/wopian/kitsu/blob/master/LICENSE.md

‎packages/kitsu/types/index.d.ts‎

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -128,28 +128,47 @@ export default class Kitsu {
128128
* @returns {Object} JSON-parsed response
129129
* @example <caption>Getting a resource with JSON:API parameters</caption>
130130
* api.get('users', {
131-
* fields: {
132-
* users: 'name,birthday'
133-
* },
134-
* filter: {
135-
* name: 'wopian'
131+
* params: {
132+
* fields: {
133+
* users: 'name,birthday'
134+
* },
135+
* filter: {
136+
* name: 'wopian'
137+
* }
136138
* }
137139
* })
138140
* @example <caption>Getting a collection of resources with their relationships</caption>
139141
* api.get('anime', {
140-
* include: 'categories'
142+
* params: {
143+
* include: 'categories'
144+
* }
141145
* })
142146
* @example <caption>Getting a single resource by ID (method one)</caption>
143147
* api.get('anime/2', {
144-
* include: 'categories'
148+
* params: {
149+
* include: 'categories'
150+
* }
145151
* })
146152
* @example <caption>Getting a single resource by ID (method two)</caption>
147153
* api.get('anime', {
148-
* include: 'categories',
149-
* filter: { id: '2' }
154+
* params: {
155+
* include: 'categories',
156+
* filter: { id: '2' }
157+
* }
150158
* })
151159
* @example <caption>Getting a resource's relationship data only</caption>
152160
* api.get('anime/2/categories')
161+
* @example <caption>Getting a resource with nested JSON:API filters (not supported by Kitsu.io's API)</caption>
162+
* // resource?filter[x][y]=value
163+
* api.get('resource', {
164+
* params: {
165+
* filter: {
166+
* x: {
167+
* y: 'value'
168+
* }
169+
* }
170+
* }
171+
* }
153172
* @example <caption>Handling errors (async/await)</caption>
154173
* try {
155174
* const { data } = await api.get('anime')
@@ -300,8 +319,10 @@ export default class Kitsu {
300319
* api.self()
301320
* @example <caption>Using JSON:API parameters</caption>
302321
* api.self({
303-
* fields: {
304-
* users: 'name,birthday'
322+
* params: {
323+
* fields: {
324+
* users: 'name,birthday'
325+
* }
305326
* }
306327
* })
307328
*/

0 commit comments

Comments
 (0)
⚡