Skip to content

Commit 2df72e7

Browse files
committed
chore(release): update documentation
1 parent af7db19 commit 2df72e7

2 files changed

Lines changed: 20 additions & 20 deletions

File tree

packages/kitsu-core/README.md

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

119119
### deattribute
120120

121-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
121+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
122122

123123
Hoists attributes to be top-level
124124

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

163163
### deserialise
164164

165-
[packages/kitsu-core/src/deserialise/index.js:57-74](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu-core/src/deserialise/index.js#L57-L74 "Source code on GitHub")
165+
[packages/kitsu-core/src/deserialise/index.js:57-74](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/deserialise/index.js#L57-L74 "Source code on GitHub")
166166

167167
Deserialises a JSON-API response
168168

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

215215
### error
216216

217-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
217+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
218218

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

@@ -251,7 +251,7 @@ error({
251251

252252
### filterIncludes
253253

254-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
254+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
255255

256256
Filters includes for the specific relationship requested
257257

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

291291
### linkRelationships
292292

293-
[packages/kitsu-core/src/linkRelationships/index.js:98-119](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu-core/src/linkRelationships/index.js#L98-L119 "Source code on GitHub")
293+
[packages/kitsu-core/src/linkRelationships/index.js:98-119](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/linkRelationships/index.js#L98-L119 "Source code on GitHub")
294294

295295
Links relationships to included data
296296

@@ -328,7 +328,7 @@ Returns **any** Parsed data
328328

329329
### query
330330

331-
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
331+
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
332332

333333
Constructs a URL query string for JSON:API parameters
334334

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

357357
### serialise
358358

359-
[packages/kitsu-core/src/serialise/index.js:119-152](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu-core/src/serialise/index.js#L119-L152 "Source code on GitHub")
359+
[packages/kitsu-core/src/serialise/index.js:119-152](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/serialise/index.js#L119-L152 "Source code on GitHub")
360360

361361
Serialises an object into a JSON-API structure
362362

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

403403
### splitModel
404404

405-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
405+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
406406

407407
Split model name from the model's resource URL
408408

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

446446
### camel
447447

448-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
448+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
449449

450450
Converts kebab-case and snake_case into camelCase
451451

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

474474
### kebab
475475

476-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
476+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
477477

478478
Converts camelCase into kebab-case
479479

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

492492
### snake
493493

494-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
494+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
495495

496496
Converts camelCase into snake_case
497497

packages/kitsu/README.md

Lines changed: 9 additions & 9 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:30-342](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu/src/index.js#L30-L342 "Source code on GitHub")
213+
[packages/kitsu/src/index.js:30-342](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu/src/index.js#L30-L342 "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:52-53](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
260+
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu/src/index.js#L52-L53 "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:67-67](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
282+
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu/src/index.js#L67-L67 "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:111-111](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu/src/index.js#L111-L111 "Source code on GitHub")
313+
[packages/kitsu/src/index.js:111-111](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu/src/index.js#L111-L111 "Source code on GitHub")
314314

315315
Axios Interceptors (alias of `axios.interceptors`)
316316

@@ -358,7 +358,7 @@ api.interceptors.request.eject(myInterceptor)
358358

359359
#### get
360360

361-
[packages/kitsu/src/index.js:184-203](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu/src/index.js#L184-L203 "Source code on GitHub")
361+
[packages/kitsu/src/index.js:184-203](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu/src/index.js#L184-L203 "Source code on GitHub")
362362

363363
Fetch resources (alias `fetch`)
364364

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

471471
#### patch
472472

473-
[packages/kitsu/src/index.js:219-239](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu/src/index.js#L219-L239 "Source code on GitHub")
473+
[packages/kitsu/src/index.js:219-239](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu/src/index.js#L219-L239 "Source code on GitHub")
474474

475475
Update a resource (alias `update`)
476476

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

497497
#### post
498498

499-
[packages/kitsu/src/index.js:262-281](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu/src/index.js#L262-L281 "Source code on GitHub")
499+
[packages/kitsu/src/index.js:262-281](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu/src/index.js#L262-L281 "Source code on GitHub")
500500

501501
Create a new resource (alias `create`)
502502

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

530530
#### delete
531531

532-
[packages/kitsu/src/index.js:294-312](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu/src/index.js#L294-L312 "Source code on GitHub")
532+
[packages/kitsu/src/index.js:294-312](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu/src/index.js#L294-L312 "Source code on GitHub")
533533

534534
Remove a resource (alias `remove`)
535535

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

553553
#### self
554554

555-
[packages/kitsu/src/index.js:334-341](https://github.com/wopian/kitsu/blob/ff05659243c024afe9a4537a480fd59a26b9ba3d/packages/kitsu/src/index.js#L334-L341 "Source code on GitHub")
555+
[packages/kitsu/src/index.js:334-341](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu/src/index.js#L334-L341 "Source code on GitHub")
556556

557557
Get the authenticated user's data
558558

0 commit comments

Comments
 (0)