Skip to content

Commit e71b1dc

Browse files
committed
chore(release): update documentation
1 parent aa56def commit e71b1dc

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

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/e29946a6e887369340dfb6e3ff3a01e2397f040e/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/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/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/e29946a6e887369340dfb6e3ff3a01e2397f040e/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/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/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/e29946a6e887369340dfb6e3ff3a01e2397f040e/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/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/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/e29946a6e887369340dfb6e3ff3a01e2397f040e/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/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/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/e29946a6e887369340dfb6e3ff3a01e2397f040e/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/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/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/e29946a6e887369340dfb6e3ff3a01e2397f040e/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/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/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/e29946a6e887369340dfb6e3ff3a01e2397f040e/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/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/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/e29946a6e887369340dfb6e3ff3a01e2397f040e/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/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/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/e29946a6e887369340dfb6e3ff3a01e2397f040e/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/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/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/e29946a6e887369340dfb6e3ff3a01e2397f040e/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/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/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/e29946a6e887369340dfb6e3ff3a01e2397f040e/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/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/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: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ If you're working with [Kitsu.io]'s API, their [API docs][kitsu.io api docs] lis
222222

223223
### Kitsu
224224

225-
[packages/kitsu/src/index.js:31-482](https://github.com/wopian/kitsu/blob/e29946a6e887369340dfb6e3ff3a01e2397f040e/packages/kitsu/src/index.js#L31-L482 "Source code on GitHub")
225+
[packages/kitsu/src/index.js:31-482](https://github.com/wopian/kitsu/blob/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/packages/kitsu/src/index.js#L31-L482 "Source code on GitHub")
226226

227227
Creates a new `kitsu` instance
228228

@@ -269,7 +269,7 @@ const api = new Kitsu({
269269

270270
#### plural
271271

272-
[packages/kitsu/src/index.js:53-54](https://github.com/wopian/kitsu/blob/e29946a6e887369340dfb6e3ff3a01e2397f040e/packages/kitsu/src/index.js#L53-L54 "Source code on GitHub")
272+
[packages/kitsu/src/index.js:53-54](https://github.com/wopian/kitsu/blob/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/packages/kitsu/src/index.js#L53-L54 "Source code on GitHub")
273273

274274
- **See: <https://www.npmjs.com/package/pluralize> for documentation
275275
**
@@ -291,7 +291,7 @@ api.plural.plural('paper') //=> 'paper'
291291

292292
#### headers
293293

294-
[packages/kitsu/src/index.js:68-68](https://github.com/wopian/kitsu/blob/e29946a6e887369340dfb6e3ff3a01e2397f040e/packages/kitsu/src/index.js#L68-L68 "Source code on GitHub")
294+
[packages/kitsu/src/index.js:68-68](https://github.com/wopian/kitsu/blob/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/packages/kitsu/src/index.js#L68-L68 "Source code on GitHub")
295295

296296
Get the current headers or add additional headers
297297

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

323323
#### interceptors
324324

325-
[packages/kitsu/src/index.js:113-113](https://github.com/wopian/kitsu/blob/e29946a6e887369340dfb6e3ff3a01e2397f040e/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub")
325+
[packages/kitsu/src/index.js:113-113](https://github.com/wopian/kitsu/blob/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub")
326326

327327
- **See: <https://github.com/axios/axios#interceptors> for documentation
328328
**
@@ -373,7 +373,7 @@ api.interceptors.request.eject(myInterceptor)
373373

374374
#### get
375375

376-
[packages/kitsu/src/index.js:191-211](https://github.com/wopian/kitsu/blob/e29946a6e887369340dfb6e3ff3a01e2397f040e/packages/kitsu/src/index.js#L191-L211 "Source code on GitHub")
376+
[packages/kitsu/src/index.js:191-211](https://github.com/wopian/kitsu/blob/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/packages/kitsu/src/index.js#L191-L211 "Source code on GitHub")
377377

378378
Fetch resources (alias `fetch`)
379379

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

491491
#### patch
492492

493-
[packages/kitsu/src/index.js:246-273](https://github.com/wopian/kitsu/blob/e29946a6e887369340dfb6e3ff3a01e2397f040e/packages/kitsu/src/index.js#L246-L273 "Source code on GitHub")
493+
[packages/kitsu/src/index.js:246-273](https://github.com/wopian/kitsu/blob/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/packages/kitsu/src/index.js#L246-L273 "Source code on GitHub")
494494

495495
Update a resource (alias `update`)
496496

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

556556
#### post
557557

558-
[packages/kitsu/src/index.js:303-328](https://github.com/wopian/kitsu/blob/e29946a6e887369340dfb6e3ff3a01e2397f040e/packages/kitsu/src/index.js#L303-L328 "Source code on GitHub")
558+
[packages/kitsu/src/index.js:303-328](https://github.com/wopian/kitsu/blob/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/packages/kitsu/src/index.js#L303-L328 "Source code on GitHub")
559559

560560
Create a new resource (alias `create`)
561561

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

601601
#### delete
602602

603-
[packages/kitsu/src/index.js:345-378](https://github.com/wopian/kitsu/blob/e29946a6e887369340dfb6e3ff3a01e2397f040e/packages/kitsu/src/index.js#L345-L378 "Source code on GitHub")
603+
[packages/kitsu/src/index.js:345-378](https://github.com/wopian/kitsu/blob/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/packages/kitsu/src/index.js#L345-L378 "Source code on GitHub")
604604

605605
Remove a resource (alias `remove`)
606606

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

633633
#### self
634634

635-
[packages/kitsu/src/index.js:399-408](https://github.com/wopian/kitsu/blob/e29946a6e887369340dfb6e3ff3a01e2397f040e/packages/kitsu/src/index.js#L399-L408 "Source code on GitHub")
635+
[packages/kitsu/src/index.js:399-408](https://github.com/wopian/kitsu/blob/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/packages/kitsu/src/index.js#L399-L408 "Source code on GitHub")
636636

637637
Get the authenticated user's data
638638

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

669669
#### request
670670

671-
[packages/kitsu/src/index.js:462-481](https://github.com/wopian/kitsu/blob/e29946a6e887369340dfb6e3ff3a01e2397f040e/packages/kitsu/src/index.js#L462-L481 "Source code on GitHub")
671+
[packages/kitsu/src/index.js:462-481](https://github.com/wopian/kitsu/blob/aa56def40bd02c3e0fd7bb26f7e67596cc5063ad/packages/kitsu/src/index.js#L462-L481 "Source code on GitHub")
672672

673673
Send arbitrary requests
674674

0 commit comments

Comments
 (0)