Skip to content

Commit 95c3fbb

Browse files
committed
chore(release): update documentation
1 parent a5c501a commit 95c3fbb

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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/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-74](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu-core/src/deserialise/index.js#L57-L74 "Source code on GitHub")
161+
[packages/kitsu-core/src/deserialise/index.js:57-74](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu-core/src/deserialise/index.js#L57-L74 "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:7-13](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu-core/src/error/index.js#L7-L13 "Source code on GitHub")
213+
[packages/kitsu-core/src/error/index.js:7-13](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu-core/src/error/index.js#L7-L13 "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

@@ -223,7 +223,7 @@ Uniform error handling for Axios, JSON:API and internal package errors. Mutated
223223

224224
### filterIncludes
225225

226-
[packages/kitsu-core/src/filterIncludes/index.js:12-25](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu-core/src/filterIncludes/index.js#L12-L25 "Source code on GitHub")
226+
[packages/kitsu-core/src/filterIncludes/index.js:12-25](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu-core/src/filterIncludes/index.js#L12-L25 "Source code on GitHub")
227227

228228
Filters includes for the specific relationship
229229

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

239239
### linkRelationships
240240

241-
[packages/kitsu-core/src/linkRelationships/index.js:75-96](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu-core/src/linkRelationships/index.js#L75-L96 "Source code on GitHub")
241+
[packages/kitsu-core/src/linkRelationships/index.js:75-96](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu-core/src/linkRelationships/index.js#L75-L96 "Source code on GitHub")
242242

243243
Links relationships to included data
244244

@@ -249,7 +249,7 @@ Links relationships to included data
249249

250250
### query
251251

252-
[packages/kitsu-core/src/query/index.js:21-32](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu-core/src/query/index.js#L21-L32 "Source code on GitHub")
252+
[packages/kitsu-core/src/query/index.js:21-32](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu-core/src/query/index.js#L21-L32 "Source code on GitHub")
253253

254254
Constructs a URL query string for JSON:API parameters
255255

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

263263
### serialise
264264

265-
[packages/kitsu-core/src/serialise/index.js:119-152](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu-core/src/serialise/index.js#L119-L152 "Source code on GitHub")
265+
[packages/kitsu-core/src/serialise/index.js:119-152](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu-core/src/serialise/index.js#L119-L152 "Source code on GitHub")
266266

267267
Serialises an object into a JSON-API structure
268268

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

309309
### splitModel
310310

311-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
311+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
312312

313313
Split model name from the model's resource URL
314314

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

352352
### camel
353353

354-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
354+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
355355

356356
Converts kebab-case and snake_case into camelCase
357357

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

380380
### kebab
381381

382-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
382+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
383383

384384
Converts camelCase into kebab-case
385385

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

398398
### snake
399399

400-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
400+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
401401

402402
Converts camelCase into snake_case
403403

packages/kitsu/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu/MIGRATING.md>Migration guide</a> for v9 and previous major releases</p>
3030

31-
#
31+
#
3232

3333
## Features
3434

@@ -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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/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)