Skip to content

Commit ba00f68

Browse files
committed
chore(release): update documentation
1 parent 3fcd884 commit ba00f68

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

115115
### deattribute
116116

117-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
117+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
118118

119119
Hoists attributes to be top-level
120120

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

159159
### deserialise
160160

161-
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
161+
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
162162

163163
Deserialises a JSON-API response
164164

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

211211
### error
212212

213-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
213+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
214214

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

@@ -247,7 +247,7 @@ error({
247247

248248
### filterIncludes
249249

250-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
250+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
251251

252252
Filters includes for the specific relationship requested
253253

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

287287
### linkRelationships
288288

289-
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
289+
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
290290

291291
Links relationships to included data
292292

@@ -324,7 +324,7 @@ Returns **any** Parsed data
324324

325325
### query
326326

327-
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
327+
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
328328

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

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

353353
### serialise
354354

355-
[packages/kitsu-core/src/serialise/index.js:249-260](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/serialise/index.js#L249-L260 "Source code on GitHub")
355+
[packages/kitsu-core/src/serialise/index.js:249-260](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/serialise/index.js#L249-L260 "Source code on GitHub")
356356

357357
Serialises an object into a JSON-API structure
358358

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

399399
### splitModel
400400

401-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
401+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
402402

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

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

442442
### camel
443443

444-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
444+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
445445

446446
Converts kebab-case and snake_case into camelCase
447447

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

470470
### kebab
471471

472-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
472+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
473473

474474
Converts camelCase into kebab-case
475475

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

488488
### snake
489489

490-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
490+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
491491

492492
Converts camelCase into snake_case
493493

packages/kitsu/README.md

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

210210
### Kitsu
211211

212-
[packages/kitsu/src/index.js:30-463](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L30-L463 "Source code on GitHub")
212+
[packages/kitsu/src/index.js:30-464](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu/src/index.js#L30-L464 "Source code on GitHub")
213213

214214
Creates a new `kitsu` instance
215215

@@ -256,7 +256,7 @@ const api = new Kitsu({
256256

257257
#### plural
258258

259-
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
259+
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
260260

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

279279
#### headers
280280

281-
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
281+
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
282282

283283
Get the current headers or add additional headers
284284

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

310310
#### interceptors
311311

312-
[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
312+
[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
313313

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

361361
#### get
362362

363-
[packages/kitsu/src/index.js:189-208](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L189-L208 "Source code on GitHub")
363+
[packages/kitsu/src/index.js:189-208](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu/src/index.js#L189-L208 "Source code on GitHub")
364364

365365
Fetch resources (alias `fetch`)
366366

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

477477
#### patch
478478

479-
[packages/kitsu/src/index.js:241-261](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L241-L261 "Source code on GitHub")
479+
[packages/kitsu/src/index.js:241-262](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu/src/index.js#L241-L262 "Source code on GitHub")
480480

481481
Update a resource (alias `update`)
482482

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

540540
#### post
541541

542-
[packages/kitsu/src/index.js:289-308](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L289-L308 "Source code on GitHub")
542+
[packages/kitsu/src/index.js:290-309](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu/src/index.js#L290-L309 "Source code on GitHub")
543543

544544
Create a new resource (alias `create`)
545545

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

583583
#### delete
584584

585-
[packages/kitsu/src/index.js:323-352](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L323-L352 "Source code on GitHub")
585+
[packages/kitsu/src/index.js:324-353](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu/src/index.js#L324-L353 "Source code on GitHub")
586586

587587
Remove a resource (alias `remove`)
588588

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

613613
#### self
614614

615-
[packages/kitsu/src/index.js:374-381](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L374-L381 "Source code on GitHub")
615+
[packages/kitsu/src/index.js:375-382](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu/src/index.js#L375-L382 "Source code on GitHub")
616616

617617
Get the authenticated user's data
618618

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

650650
#### request
651651

652-
[packages/kitsu/src/index.js:442-462](https://github.com/wopian/kitsu/blob/8811addad1e0d7752ee1b0acc52cbd72bf485c86/packages/kitsu/src/index.js#L442-L462 "Source code on GitHub")
652+
[packages/kitsu/src/index.js:443-463](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu/src/index.js#L443-L463 "Source code on GitHub")
653653

654654
Send arbitrary requests
655655

0 commit comments

Comments
 (0)