Skip to content

Commit fa0cdd8

Browse files
committed
chore(release): update documentation
1 parent a8a06dd commit fa0cdd8

2 files changed

Lines changed: 21 additions & 21 deletions

File tree

packages/kitsu-core/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ kitsuCore.camel(...)
116116

117117
### deattribute
118118

119-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
119+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
120120

121121
Hoists attributes to be top-level
122122

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

161161
### deserialise
162162

163-
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
163+
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
164164

165165
Deserialises a JSON-API response
166166

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

213213
### error
214214

215-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
215+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
216216

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

@@ -249,7 +249,7 @@ error({
249249

250250
### filterIncludes
251251

252-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
252+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
253253

254254
Filters includes for the specific relationship requested
255255

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

289289
### linkRelationships
290290

291-
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
291+
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
292292

293293
Links relationships to included data
294294

@@ -326,7 +326,7 @@ Returns **any** Parsed data
326326

327327
### query
328328

329-
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
329+
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
330330

331331
Constructs a URL query string for JSON:API parameters
332332

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

355355
### serialise
356356

357-
[packages/kitsu-core/src/serialise/index.js:249-260](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu-core/src/serialise/index.js#L249-L260 "Source code on GitHub")
357+
[packages/kitsu-core/src/serialise/index.js:249-260](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu-core/src/serialise/index.js#L249-L260 "Source code on GitHub")
358358

359359
Serialises an object into a JSON-API structure
360360

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

401401
### splitModel
402402

403-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
403+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
404404

405405
Split model name from the model's resource URL
406406

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

444444
### camel
445445

446-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
446+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
447447

448448
Converts kebab-case and snake_case into camelCase
449449

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

472472
### kebab
473473

474-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
474+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
475475

476476
Converts camelCase into kebab-case
477477

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

490490
### snake
491491

492-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
492+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
493493

494494
Converts camelCase into snake_case
495495

packages/kitsu/README.md

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

214214
### Kitsu
215215

216-
[packages/kitsu/src/index.js:30-463](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu/src/index.js#L30-L463 "Source code on GitHub")
216+
[packages/kitsu/src/index.js:30-463](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu/src/index.js#L30-L463 "Source code on GitHub")
217217

218218
Creates a new `kitsu` instance
219219

@@ -260,7 +260,7 @@ const api = new Kitsu({
260260

261261
#### plural
262262

263-
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
263+
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
264264

265265
- **See: <https://www.npmjs.com/package/pluralize> for documentation
266266
**
@@ -282,7 +282,7 @@ api.plural.plural('paper') //=> 'paper'
282282

283283
#### headers
284284

285-
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
285+
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
286286

287287
Get the current headers or add additional headers
288288

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

314314
#### interceptors
315315

316-
[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
316+
[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
317317

318318
- **See: <https://github.com/axios/axios#interceptors> for documentation
319319
**
@@ -364,7 +364,7 @@ api.interceptors.request.eject(myInterceptor)
364364

365365
#### get
366366

367-
[packages/kitsu/src/index.js:189-208](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu/src/index.js#L189-L208 "Source code on GitHub")
367+
[packages/kitsu/src/index.js:189-208](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu/src/index.js#L189-L208 "Source code on GitHub")
368368

369369
Fetch resources (alias `fetch`)
370370

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

481481
#### patch
482482

483-
[packages/kitsu/src/index.js:241-261](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu/src/index.js#L241-L261 "Source code on GitHub")
483+
[packages/kitsu/src/index.js:241-261](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu/src/index.js#L241-L261 "Source code on GitHub")
484484

485485
Update a resource (alias `update`)
486486

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

544544
#### post
545545

546-
[packages/kitsu/src/index.js:289-308](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu/src/index.js#L289-L308 "Source code on GitHub")
546+
[packages/kitsu/src/index.js:289-308](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu/src/index.js#L289-L308 "Source code on GitHub")
547547

548548
Create a new resource (alias `create`)
549549

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

587587
#### delete
588588

589-
[packages/kitsu/src/index.js:323-352](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu/src/index.js#L323-L352 "Source code on GitHub")
589+
[packages/kitsu/src/index.js:323-352](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu/src/index.js#L323-L352 "Source code on GitHub")
590590

591591
Remove a resource (alias `remove`)
592592

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

617617
#### self
618618

619-
[packages/kitsu/src/index.js:374-381](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu/src/index.js#L374-L381 "Source code on GitHub")
619+
[packages/kitsu/src/index.js:374-381](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu/src/index.js#L374-L381 "Source code on GitHub")
620620

621621
Get the authenticated user's data
622622

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

654654
#### request
655655

656-
[packages/kitsu/src/index.js:442-462](https://github.com/wopian/kitsu/blob/cbdc45e8d447105da87d2bf716f1120d8775b5f8/packages/kitsu/src/index.js#L442-L462 "Source code on GitHub")
656+
[packages/kitsu/src/index.js:442-462](https://github.com/wopian/kitsu/blob/a8a06dd531562c788b8a5ebb2d016e1fd01d2db7/packages/kitsu/src/index.js#L442-L462 "Source code on GitHub")
657657

658658
Send arbitrary requests
659659

0 commit comments

Comments
 (0)