Skip to content

Commit 883512b

Browse files
committed
chore(release): update documentation
1 parent af5ac6b commit 883512b

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
@@ -115,7 +115,7 @@ kitsuCore.camel(...)
115115

116116
### deattribute
117117

118-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
118+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
119119

120120
Hoists attributes to be top-level
121121

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

160160
### deserialise
161161

162-
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
162+
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
163163

164164
Deserialises a JSON-API response
165165

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

212212
### error
213213

214-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
214+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
215215

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

@@ -248,7 +248,7 @@ error({
248248

249249
### filterIncludes
250250

251-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
251+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
252252

253253
Filters includes for the specific relationship requested
254254

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

288288
### linkRelationships
289289

290-
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
290+
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
291291

292292
Links relationships to included data
293293

@@ -325,7 +325,7 @@ Returns **any** Parsed data
325325

326326
### query
327327

328-
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
328+
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
329329

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

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

354354
### serialise
355355

356-
[packages/kitsu-core/src/serialise/index.js:210-221](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/serialise/index.js#L210-L221 "Source code on GitHub")
356+
[packages/kitsu-core/src/serialise/index.js:210-221](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/serialise/index.js#L210-L221 "Source code on GitHub")
357357

358358
Serialises an object into a JSON-API structure
359359

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

400400
### splitModel
401401

402-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
402+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
403403

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

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

443443
### camel
444444

445-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
445+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
446446

447447
Converts kebab-case and snake_case into camelCase
448448

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

471471
### kebab
472472

473-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
473+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
474474

475475
Converts camelCase into kebab-case
476476

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

489489
### snake
490490

491-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
491+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
492492

493493
Converts camelCase into snake_case
494494

packages/kitsu/README.md

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

211211
### Kitsu
212212

213-
[packages/kitsu/src/index.js:31-482](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu/src/index.js#L31-L482 "Source code on GitHub")
213+
[packages/kitsu/src/index.js:31-482](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L31-L482 "Source code on GitHub")
214214

215215
Creates a new `kitsu` instance
216216

@@ -257,7 +257,7 @@ const api = new Kitsu({
257257

258258
#### plural
259259

260-
[packages/kitsu/src/index.js:53-54](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu/src/index.js#L53-L54 "Source code on GitHub")
260+
[packages/kitsu/src/index.js:53-54](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L53-L54 "Source code on GitHub")
261261

262262
- **See: <https://www.npmjs.com/package/pluralize> for documentation
263263
**
@@ -279,7 +279,7 @@ api.plural.plural('paper') //=> 'paper'
279279

280280
#### headers
281281

282-
[packages/kitsu/src/index.js:68-68](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu/src/index.js#L68-L68 "Source code on GitHub")
282+
[packages/kitsu/src/index.js:68-68](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L68-L68 "Source code on GitHub")
283283

284284
Get the current headers or add additional headers
285285

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

311311
#### interceptors
312312

313-
[packages/kitsu/src/index.js:113-113](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub")
313+
[packages/kitsu/src/index.js:113-113](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L113-L113 "Source code on GitHub")
314314

315315
- **See: <https://github.com/axios/axios#interceptors> for documentation
316316
**
@@ -361,7 +361,7 @@ api.interceptors.request.eject(myInterceptor)
361361

362362
#### get
363363

364-
[packages/kitsu/src/index.js:191-211](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu/src/index.js#L191-L211 "Source code on GitHub")
364+
[packages/kitsu/src/index.js:191-211](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L191-L211 "Source code on GitHub")
365365

366366
Fetch resources (alias `fetch`)
367367

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

479479
#### patch
480480

481-
[packages/kitsu/src/index.js:246-273](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu/src/index.js#L246-L273 "Source code on GitHub")
481+
[packages/kitsu/src/index.js:246-273](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L246-L273 "Source code on GitHub")
482482

483483
Update a resource (alias `update`)
484484

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

544544
#### post
545545

546-
[packages/kitsu/src/index.js:303-328](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu/src/index.js#L303-L328 "Source code on GitHub")
546+
[packages/kitsu/src/index.js:303-328](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L303-L328 "Source code on GitHub")
547547

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

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

589589
#### delete
590590

591-
[packages/kitsu/src/index.js:345-378](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu/src/index.js#L345-L378 "Source code on GitHub")
591+
[packages/kitsu/src/index.js:345-378](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L345-L378 "Source code on GitHub")
592592

593593
Remove a resource (alias `remove`)
594594

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

621621
#### self
622622

623-
[packages/kitsu/src/index.js:399-408](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu/src/index.js#L399-L408 "Source code on GitHub")
623+
[packages/kitsu/src/index.js:399-408](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L399-L408 "Source code on GitHub")
624624

625625
Get the authenticated user's data
626626

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

657657
#### request
658658

659-
[packages/kitsu/src/index.js:462-481](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu/src/index.js#L462-L481 "Source code on GitHub")
659+
[packages/kitsu/src/index.js:462-481](https://github.com/wopian/kitsu/blob/af5ac6b7f8c58b62c022c93dc5b178426a33fe3b/packages/kitsu/src/index.js#L462-L481 "Source code on GitHub")
660660

661661
Send arbitrary requests
662662

0 commit comments

Comments
 (0)