Skip to content

Commit 84d00c5

Browse files
committed
chore(release): update documentation
1 parent 1fc81d9 commit 84d00c5

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

115115
### deattribute
116116

117-
[packages/kitsu-core/src/deattribute/index.js:29-38](https://github.com/wopian/kitsu/blob/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu-core/src/deattribute/index.js#L29-L38 "Source code on GitHub")
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")
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/bf282af3ea6662f771434821495f27b01c2dc3c8/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/bf282af3ea6662f771434821495f27b01c2dc3c8/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/bf282af3ea6662f771434821495f27b01c2dc3c8/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/bf282af3ea6662f771434821495f27b01c2dc3c8/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/bf282af3ea6662f771434821495f27b01c2dc3c8/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/bf282af3ea6662f771434821495f27b01c2dc3c8/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/bf282af3ea6662f771434821495f27b01c2dc3c8/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/bf282af3ea6662f771434821495f27b01c2dc3c8/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/bf282af3ea6662f771434821495f27b01c2dc3c8/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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/bf282af3ea6662f771434821495f27b01c2dc3c8/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/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/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: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ If you're working with [Kitsu.io]'s API, their [API docs][kitsu.io api docs] lis
194194

195195
### Kitsu
196196

197-
[packages/kitsu/src/index.js:30-342](https://github.com/wopian/kitsu/blob/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu/src/index.js#L30-L342 "Source code on GitHub")
197+
[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")
198198

199199
Creates a new `kitsu` instance
200200

@@ -241,7 +241,7 @@ const api = new Kitsu({
241241

242242
#### plural
243243

244-
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
244+
[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")
245245

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

264264
#### headers
265265

266-
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
266+
[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")
267267

268268
Get the current headers or add additional headers
269269

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

295295
#### interceptors
296296

297-
[packages/kitsu/src/index.js:111-111](https://github.com/wopian/kitsu/blob/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu/src/index.js#L111-L111 "Source code on GitHub")
297+
[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")
298298

299299
Axios Interceptors (alias of `axios.interceptors`)
300300

@@ -342,7 +342,7 @@ api.interceptors.request.eject(myInterceptor)
342342

343343
#### get
344344

345-
[packages/kitsu/src/index.js:184-203](https://github.com/wopian/kitsu/blob/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu/src/index.js#L184-L203 "Source code on GitHub")
345+
[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")
346346

347347
Fetch resources (alias `fetch`)
348348

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

455455
#### patch
456456

457-
[packages/kitsu/src/index.js:219-239](https://github.com/wopian/kitsu/blob/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu/src/index.js#L219-L239 "Source code on GitHub")
457+
[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")
458458

459459
Update a resource (alias `update`)
460460

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

481481
#### post
482482

483-
[packages/kitsu/src/index.js:262-281](https://github.com/wopian/kitsu/blob/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu/src/index.js#L262-L281 "Source code on GitHub")
483+
[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")
484484

485485
Create a new resource (alias `create`)
486486

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

514514
#### delete
515515

516-
[packages/kitsu/src/index.js:294-312](https://github.com/wopian/kitsu/blob/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu/src/index.js#L294-L312 "Source code on GitHub")
516+
[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")
517517

518518
Remove a resource (alias `remove`)
519519

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

537537
#### self
538538

539-
[packages/kitsu/src/index.js:334-341](https://github.com/wopian/kitsu/blob/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu/src/index.js#L334-L341 "Source code on GitHub")
539+
[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")
540540

541541
Get the authenticated user's data
542542

0 commit comments

Comments
 (0)