Skip to content

Commit 03ec026

Browse files
wopianwopian
committed
chore(release): update documentation
1 parent bf282af commit 03ec026

2 files changed

Lines changed: 24 additions & 26 deletions

File tree

‎packages/kitsu-core/README.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@
2626

2727
<p align=center>Core <a href=http://jsonapi.org>JSON:API</a> serialisation and deserialisation components</p>
2828

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

32-
#
31+
#
3332

3433
## Features
3534

@@ -115,7 +114,7 @@ kitsuCore.camel(...)
115114

116115
### deattribute
117116

118-
[packages/kitsu-core/src/deattribute/index.js:29-38](https://github.com/wopian/kitsu/blob/8576749f2211c86ac5fcbada6328efdf023c8eb4/packages/kitsu-core/src/deattribute/index.js#L29-L38 "Source code on GitHub")
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")
119118

120119
Hoists attributes to be top-level
121120

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

160159
### deserialise
161160

162-
[packages/kitsu-core/src/deserialise/index.js:57-74](https://github.com/wopian/kitsu/blob/8576749f2211c86ac5fcbada6328efdf023c8eb4/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/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu-core/src/deserialise/index.js#L57-L74 "Source code on GitHub")
163162

164163
Deserialises a JSON-API response
165164

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

212211
### error
213212

214-
[packages/kitsu-core/src/error/index.js:7-13](https://github.com/wopian/kitsu/blob/8576749f2211c86ac5fcbada6328efdf023c8eb4/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/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu-core/src/error/index.js#L7-L13 "Source code on GitHub")
215214

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

@@ -224,22 +223,22 @@ Uniform error handling for Axios, JSON:API and internal package errors. Mutated
224223

225224
### filterIncludes
226225

227-
[packages/kitsu-core/src/filterIncludes/index.js:12-25](https://github.com/wopian/kitsu/blob/8576749f2211c86ac5fcbada6328efdf023c8eb4/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/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu-core/src/filterIncludes/index.js#L12-L25 "Source code on GitHub")
228227

229228
Filters includes for the specific relationship
230229

231230
#### Parameters
232231

233232
- `included` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The response included object
234-
- `opts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
233+
- `opts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
235234
- `opts.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship ID
236235
- `opts.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship type
237236

238237
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** The matched includes
239238

240239
### linkRelationships
241240

242-
[packages/kitsu-core/src/linkRelationships/index.js:75-96](https://github.com/wopian/kitsu/blob/8576749f2211c86ac5fcbada6328efdf023c8eb4/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/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu-core/src/linkRelationships/index.js#L75-L96 "Source code on GitHub")
243242

244243
Links relationships to included data
245244

@@ -250,7 +249,7 @@ Links relationships to included data
250249

251250
### query
252251

253-
[packages/kitsu-core/src/query/index.js:21-32](https://github.com/wopian/kitsu/blob/8576749f2211c86ac5fcbada6328efdf023c8eb4/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/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu-core/src/query/index.js#L21-L32 "Source code on GitHub")
254253

255254
Constructs a URL query string for JSON:API parameters
256255

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

264263
### serialise
265264

266-
[packages/kitsu-core/src/serialise/index.js:119-152](https://github.com/wopian/kitsu/blob/8576749f2211c86ac5fcbada6328efdf023c8eb4/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/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu-core/src/serialise/index.js#L119-L152 "Source code on GitHub")
267266

268267
Serialises an object into a JSON-API structure
269268

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

310309
### splitModel
311310

312-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/8576749f2211c86ac5fcbada6328efdf023c8eb4/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/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
313312

314313
Split model name from the model's resource URL
315314

316315
#### Parameters
317316

318317
- `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** URL path for the model
319-
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
318+
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
320319
- `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
321320
- `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)
322321

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

353352
### camel
354353

355-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/8576749f2211c86ac5fcbada6328efdf023c8eb4/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/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
356355

357356
Converts kebab-case and snake_case into camelCase
358357

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

381380
### kebab
382381

383-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/8576749f2211c86ac5fcbada6328efdf023c8eb4/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/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
384383

385384
Converts camelCase into kebab-case
386385

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

399398
### snake
400399

401-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/8576749f2211c86ac5fcbada6328efdf023c8eb4/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/bf282af3ea6662f771434821495f27b01c2dc3c8/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
402401

403402
Converts camelCase into snake_case
404403

‎packages/kitsu/README.md‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@
2626

2727
<p align=center>A simple, lightweight & framework agnostic <a href=http://jsonapi.org>JSON:API</a> client for <a href=https://kitsu.io>Kitsu.io</a> and other APIs</p>
2828

29-
3029
<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>
3130

32-
#
31+
#
3332

3433
## Features
3534

@@ -195,7 +194,7 @@ If you're working with [Kitsu.io]'s API, their [API docs][kitsu.io api docs] lis
195194

196195
### Kitsu
197196

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

200199
Creates a new `kitsu` instance
201200

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

243242
#### plural
244243

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

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

265264
#### headers
266265

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

269268
Get the current headers or add additional headers
270269

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

296295
#### interceptors
297296

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

300299
Axios Interceptors (alias of `axios.interceptors`)
301300

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

344343
#### get
345344

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

348347
Fetch resources (alias `fetch`)
349348

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

456455
#### patch
457456

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

460459
Update a resource (alias `update`)
461460

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

482481
#### post
483482

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

486485
Create a new resource (alias `create`)
487486

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

515514
#### delete
516515

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

519518
Remove a resource (alias `remove`)
520519

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

538537
#### self
539538

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

542541
Get the authenticated user's data
543542

0 commit comments

Comments
 (0)
⚡