Skip to content

Commit 03fc40e

Browse files
wopianwopian
committed
chore(release): update documentation
1 parent c9ba1b6 commit 03fc40e

2 files changed

Lines changed: 26 additions & 26 deletions

File tree

‎packages/kitsu-core/README.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@
3838

3939
## Node / Browser Support
4040

41-
| Package | Package<br> Size\* | Node | Chrome | Firefox | Safari | Edge |
42-
| ------------: | :----------------: | :--: | :----: | :-----: | :----: | :--: |
43-
| `kitsu-core` | ≤ 1.4 kb | 10+ | 79+ | 68+ | 12.1+ | 18+ |
41+
| Package | Package<br> Size\* | Node | Chrome | Firefox | Safari | Edge |
42+
| -----------: | :----------------: | :--: | :----: | :-----: | :----: | :--: |
43+
| `kitsu-core` | ≤ 1.4 kb | 10+ | 79+ | 68+ | 12.1+ | 18+ |
4444

4545
\* Including all dependencies, minified & gzipped<br>
4646

@@ -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/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/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/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/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-74](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/deserialise/index.js#L57-L74 "Source code on GitHub")
163+
[packages/kitsu-core/src/deserialise/index.js:57-74](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/deserialise/index.js#L57-L74 "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/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/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/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/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/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/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/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/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:98-119](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/linkRelationships/index.js#L98-L119 "Source code on GitHub")
291+
[packages/kitsu-core/src/linkRelationships/index.js:98-118](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/linkRelationships/index.js#L98-L118 "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/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/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/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/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:119-152](https://github.com/wopian/kitsu/blob/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/packages/kitsu-core/src/serialise/index.js#L119-L152 "Source code on GitHub")
357+
[packages/kitsu-core/src/serialise/index.js:119-152](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/packages/kitsu-core/src/serialise/index.js#L119-L152 "Source code on GitHub")
358358

359359
Serialises an object into a JSON-API structure
360360

@@ -400,7 +400,7 @@ 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/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/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/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/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

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

444444
### camel
445445

446-
[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")
446+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/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/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/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/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/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/af7db19d0f8d98f14ff8cdde6d2f0a519249c5e0/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/c9ba1b65f16980526aed9fecc7c1b5c8ff828db9/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: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@
4040

4141
## Node / Browser Support
4242

43-
| Package | Package<br> Size\* | Node | Chrome | Firefox | Safari | Edge |
44-
| -------: | :----------------: | :--: | :----: | :-----: | :----: | :--: |
45-
| `kitsu` | ≤ 8.6 kb | 10+ | 79+ | 68+ | 12.1+ | 18+ |
43+
| Package | Package<br> Size\* | Node | Chrome | Firefox | Safari | Edge |
44+
| ------: | :----------------: | :--: | :----: | :-----: | :----: | :--: |
45+
| `kitsu` | ≤ 8.6 kb | 10+ | 79+ | 68+ | 12.1+ | 18+ |
4646

4747
\* Including all dependencies, minified & gzipped
4848

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

212212
### Kitsu
213213

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

216216
Creates a new `kitsu` instance
217217

@@ -258,7 +258,7 @@ const api = new Kitsu({
258258

259259
#### plural
260260

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

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

281281
#### headers
282282

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

285285
Get the current headers or add additional headers
286286

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

312312
#### interceptors
313313

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

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

@@ -359,7 +359,7 @@ api.interceptors.request.eject(myInterceptor)
359359

360360
#### get
361361

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

364364
Fetch resources (alias `fetch`)
365365

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

472472
#### patch
473473

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

476476
Update a resource (alias `update`)
477477

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

498498
#### post
499499

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

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

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

531531
#### delete
532532

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

535535
Remove a resource (alias `remove`)
536536

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

554554
#### self
555555

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

558558
Get the authenticated user's data
559559

0 commit comments

Comments
 (0)
⚡