Skip to content

Commit 20e7cc6

Browse files
wopianwopian
committed
chore(release): update documentation
1 parent ee2c35e commit 20e7cc6

2 files changed

Lines changed: 23 additions & 23 deletions

File tree

‎packages/kitsu-core/README.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ kitsuCore.camel(...)
116116

117117
### deattribute
118118

119-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/95eb9c1315f3ef229c3374e740e6af024b3ab60a/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
119+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
120120

121121
Hoists attributes to be top-level
122122

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

161161
### deserialise
162162

163-
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/95eb9c1315f3ef229c3374e740e6af024b3ab60a/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
163+
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
164164

165165
Deserialises a JSON-API response
166166

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

213213
### error
214214

215-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/95eb9c1315f3ef229c3374e740e6af024b3ab60a/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
215+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
216216

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

@@ -249,7 +249,7 @@ error({
249249

250250
### filterIncludes
251251

252-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/95eb9c1315f3ef229c3374e740e6af024b3ab60a/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
252+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
253253

254254
Filters includes for the specific relationship requested
255255

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

289289
### linkRelationships
290290

291-
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/95eb9c1315f3ef229c3374e740e6af024b3ab60a/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
291+
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
292292

293293
Links relationships to included data
294294

@@ -326,7 +326,7 @@ Returns **any** Parsed data
326326

327327
### query
328328

329-
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/95eb9c1315f3ef229c3374e740e6af024b3ab60a/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
329+
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
330330

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

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

355355
### serialise
356356

357-
[packages/kitsu-core/src/serialise/index.js:191-202](https://github.com/wopian/kitsu/blob/95eb9c1315f3ef229c3374e740e6af024b3ab60a/packages/kitsu-core/src/serialise/index.js#L191-L202 "Source code on GitHub")
357+
[packages/kitsu-core/src/serialise/index.js:191-202](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu-core/src/serialise/index.js#L191-L202 "Source code on GitHub")
358358

359359
Serialises an object into a JSON-API structure
360360

@@ -400,16 +400,16 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
400400

401401
### splitModel
402402

403-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/95eb9c1315f3ef229c3374e740e6af024b3ab60a/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
403+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
404404

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

407407
#### Parameters
408408

409409
- `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** URL path for the model
410-
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**
410+
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Optional configuration for camelCase and pluralisation handling
411411
- `options.resourceCase` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Convert libraryEntries to library-entries or library_entries (default no conversion). To use parameter, import kebab or snake from kitsu-core (optional, default `s=>s`)
412-
- `options.pluralModel` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** Pluralise models (default no pluralisation). To use parameter, import pluralize (or another pluralisation npm package)
412+
- `options.pluralModel` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** Pluralise models (default no pluralisation). To use parameter, import pluralize (or another pluralisation npm package) (optional, default `s=>s`)
413413

414414
#### Examples
415415

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

444444
### camel
445445

446-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/95eb9c1315f3ef229c3374e740e6af024b3ab60a/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
446+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
447447

448448
Converts kebab-case and snake_case into camelCase
449449

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

472472
### kebab
473473

474-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/95eb9c1315f3ef229c3374e740e6af024b3ab60a/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
474+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
475475

476476
Converts camelCase into kebab-case
477477

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

490490
### snake
491491

492-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/95eb9c1315f3ef229c3374e740e6af024b3ab60a/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
492+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
493493

494494
Converts camelCase into snake_case
495495

‎packages/kitsu/README.md‎

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

214214
### Kitsu
215215

216-
[packages/kitsu/src/index.js:30-447](https://github.com/wopian/kitsu/blob/8f147ab4e5f9c4beb1eed9fecdd1cbad632e31d4/packages/kitsu/src/index.js#L30-L447 "Source code on GitHub")
216+
[packages/kitsu/src/index.js:30-447](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L30-L447 "Source code on GitHub")
217217

218218
Creates a new `kitsu` instance
219219

@@ -260,7 +260,7 @@ const api = new Kitsu({
260260

261261
#### plural
262262

263-
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/8f147ab4e5f9c4beb1eed9fecdd1cbad632e31d4/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
263+
[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
264264

265265
- **See: <https://www.npmjs.com/package/pluralize> for documentation
266266
**
@@ -282,7 +282,7 @@ api.plural.plural('paper') //=> 'paper'
282282

283283
#### headers
284284

285-
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/8f147ab4e5f9c4beb1eed9fecdd1cbad632e31d4/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
285+
[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
286286

287287
Get the current headers or add additional headers
288288

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

314314
#### interceptors
315315

316-
[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/8f147ab4e5f9c4beb1eed9fecdd1cbad632e31d4/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
316+
[packages/kitsu/src/index.js:112-112](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L112-L112 "Source code on GitHub")
317317

318318
- **See: <https://github.com/axios/axios#interceptors> for documentation
319319
**
@@ -364,7 +364,7 @@ api.interceptors.request.eject(myInterceptor)
364364

365365
#### get
366366

367-
[packages/kitsu/src/index.js:185-204](https://github.com/wopian/kitsu/blob/8f147ab4e5f9c4beb1eed9fecdd1cbad632e31d4/packages/kitsu/src/index.js#L185-L204 "Source code on GitHub")
367+
[packages/kitsu/src/index.js:185-204](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L185-L204 "Source code on GitHub")
368368

369369
Fetch resources (alias `fetch`)
370370

@@ -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:225-245](https://github.com/wopian/kitsu/blob/8f147ab4e5f9c4beb1eed9fecdd1cbad632e31d4/packages/kitsu/src/index.js#L225-L245 "Source code on GitHub")
479+
[packages/kitsu/src/index.js:225-245](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L225-L245 "Source code on GitHub")
480480

481481
Update a resource (alias `update`)
482482

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

513513
#### post
514514

515-
[packages/kitsu/src/index.js:273-292](https://github.com/wopian/kitsu/blob/8f147ab4e5f9c4beb1eed9fecdd1cbad632e31d4/packages/kitsu/src/index.js#L273-L292 "Source code on GitHub")
515+
[packages/kitsu/src/index.js:273-292](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L273-L292 "Source code on GitHub")
516516

517517
Create a new resource (alias `create`)
518518

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

556556
#### delete
557557

558-
[packages/kitsu/src/index.js:307-336](https://github.com/wopian/kitsu/blob/8f147ab4e5f9c4beb1eed9fecdd1cbad632e31d4/packages/kitsu/src/index.js#L307-L336 "Source code on GitHub")
558+
[packages/kitsu/src/index.js:307-336](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L307-L336 "Source code on GitHub")
559559

560560
Remove a resource (alias `remove`)
561561

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

586586
#### self
587587

588-
[packages/kitsu/src/index.js:358-365](https://github.com/wopian/kitsu/blob/8f147ab4e5f9c4beb1eed9fecdd1cbad632e31d4/packages/kitsu/src/index.js#L358-L365 "Source code on GitHub")
588+
[packages/kitsu/src/index.js:358-365](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L358-L365 "Source code on GitHub")
589589

590590
Get the authenticated user's data
591591

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

623623
#### request
624624

625-
[packages/kitsu/src/index.js:426-446](https://github.com/wopian/kitsu/blob/8f147ab4e5f9c4beb1eed9fecdd1cbad632e31d4/packages/kitsu/src/index.js#L426-L446 "Source code on GitHub")
625+
[packages/kitsu/src/index.js:426-446](https://github.com/wopian/kitsu/blob/ee2c35eb17e8d0a151f70d6e49222520794f866c/packages/kitsu/src/index.js#L426-L446 "Source code on GitHub")
626626

627627
Send arbitrary requests
628628

0 commit comments

Comments
 (0)
⚡