Skip to content

Commit 92d4246

Browse files
wopianwopian
committed
chore(release): update documentation
1 parent 8a7d453 commit 92d4246

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
@@ -127,7 +127,7 @@ All code released under [MIT]
127127

128128
### camel
129129

130-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
130+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
131131

132132
Converts kebab-case and snake_case into camelCase
133133

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

156156
### deattribute
157157

158-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
158+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
159159

160160
Hoists attributes to be top-level
161161

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

200200
### deserialise
201201

202-
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
202+
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
203203

204204
Deserialises a JSON-API response
205205

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

252252
### error
253253

254-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
254+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
255255

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

@@ -288,7 +288,7 @@ error({
288288

289289
### filterIncludes
290290

291-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
291+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
292292

293293
Filters includes for the specific relationship requested
294294

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

328328
### kebab
329329

330-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
330+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
331331

332332
Converts camelCase into kebab-case
333333

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

346346
### linkRelationships
347347

348-
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
348+
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
349349

350350
Links relationships to included data
351351

@@ -383,7 +383,7 @@ Returns **any** Parsed data
383383

384384
### query
385385

386-
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
386+
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
387387

388388
Constructs a URL query string for JSON:API parameters
389389

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

412412
### serialise
413413

414-
[packages/kitsu-core/src/serialise/index.js:210-221](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu-core/src/serialise/index.js#L210-L221 "Source code on GitHub")
414+
[packages/kitsu-core/src/serialise/index.js:213-224](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu-core/src/serialise/index.js#L213-L224 "Source code on GitHub")
415415

416416
Serialises an object into a JSON-API structure
417417

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

458458
### snake
459459

460-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
460+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
461461

462462
Converts camelCase into snake_case
463463

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

476476
### splitModel
477477

478-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
478+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
479479

480480
Split model name from the model's resource URL
481481

‎packages/kitsu/README.md‎

Lines changed: 10 additions & 10 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-503](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu/src/index.js#L31-L503 "Source code on GitHub")
227+
[packages/kitsu/src/index.js:31-503](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/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/b34d85434473d745bfc9ce5784704ddc3855dd3c/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/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/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/b34d85434473d745bfc9ce5784704ddc3855dd3c/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/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/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/b34d85434473d745bfc9ce5784704ddc3855dd3c/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/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/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:210-230](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu/src/index.js#L210-L230 "Source code on GitHub")
378+
[packages/kitsu/src/index.js:210-230](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu/src/index.js#L210-L230 "Source code on GitHub")
379379

380380
Fetch resources (alias `fetch`)
381381

@@ -516,7 +516,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
516516
517517
#### patch
518518
519-
[packages/kitsu/src/index.js:265-292](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu/src/index.js#L265-L292 "Source code on GitHub")
519+
[packages/kitsu/src/index.js:265-292](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu/src/index.js#L265-L292 "Source code on GitHub")
520520
521521
Update a resource (alias `update`)
522522
@@ -581,7 +581,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
581581
582582
#### post
583583
584-
[packages/kitsu/src/index.js:322-347](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu/src/index.js#L322-L347 "Source code on GitHub")
584+
[packages/kitsu/src/index.js:322-347](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu/src/index.js#L322-L347 "Source code on GitHub")
585585
586586
Create a new resource (alias `create`)
587587
@@ -626,7 +626,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
626626
627627
#### delete
628628
629-
[packages/kitsu/src/index.js:364-397](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu/src/index.js#L364-L397 "Source code on GitHub")
629+
[packages/kitsu/src/index.js:364-397](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu/src/index.js#L364-L397 "Source code on GitHub")
630630
631631
Remove a resource (alias `remove`)
632632
@@ -658,7 +658,7 @@ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
658658
659659
#### self
660660
661-
[packages/kitsu/src/index.js:420-429](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu/src/index.js#L420-L429 "Source code on GitHub")
661+
[packages/kitsu/src/index.js:420-429](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu/src/index.js#L420-L429 "Source code on GitHub")
662662
663663
Get the authenticated user's data
664664
@@ -696,7 +696,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
696696
697697
#### request
698698
699-
[packages/kitsu/src/index.js:483-502](https://github.com/wopian/kitsu/blob/b34d85434473d745bfc9ce5784704ddc3855dd3c/packages/kitsu/src/index.js#L483-L502 "Source code on GitHub")
699+
[packages/kitsu/src/index.js:483-502](https://github.com/wopian/kitsu/blob/8a7d453339bbd80393c63cad5ae6fc758fb0eb4e/packages/kitsu/src/index.js#L483-L502 "Source code on GitHub")
700700
701701
Send arbitrary requests
702702

0 commit comments

Comments
 (0)
⚡