Skip to content

Commit da50d92

Browse files
committed
chore(release): update documentation
1 parent fcd06d9 commit da50d92

4 files changed

Lines changed: 147 additions & 133 deletions

File tree

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"release": "yarn updated && yarn release:test && yarn release:commit && yarn release:lerna",
2929
"release:test": "jest && yarn lint && yarn docs:release && yarn build",
3030
"release:commit": "git commit -am \"chore(release): update documentation\"",
31-
"release:lerna": "lerna publish",
31+
"release:lerna": "lerna publish premajor",
3232
"browserlist": "npx browserslist \"last 2 years, not < 0.05%\"",
3333
"size": "lerna exec size-limit"
3434
},

packages/kitsu-core/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu-core/MIGRATING.md>Migration guide</a> for v10 & previous major releases</p>
2626

27-
#
27+
#
2828

2929
## Features
3030

@@ -38,7 +38,7 @@
3838

3939
| Package | Package<br> Size\* | ESM Size† | Node | Chrome | Firefox | Safari | Edge |
4040
| -----------: | :----------------: | :-------: | :--: | :----: | :-----: | :----: | :--: |
41-
| `kitsu-core` | ≤ 1.5 kb | ≤ 1.3 KB | 10+ | 69+ | 68+ | 12+ | 18+ |
41+
| `kitsu-core` | ≤ 1.5 kb | ≤ 1.3 KB | 10+ | 69+ | 68+ | 12+ | 18+ |
4242

4343
\* Minified with brotli
4444
† EcmaScript Modules package size\*
@@ -115,7 +115,7 @@ kitsuCore.camel(...)
115115

116116
### deattribute
117117

118-
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
118+
[packages/kitsu-core/src/deattribute/index.js:29-51](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/deattribute/index.js#L29-L51 "Source code on GitHub")
119119

120120
Hoists attributes to be top-level
121121

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

160160
### deserialise
161161

162-
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
162+
[packages/kitsu-core/src/deserialise/index.js:57-72](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/deserialise/index.js#L57-L72 "Source code on GitHub")
163163

164164
Deserialises a JSON-API response
165165

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

212212
### error
213213

214-
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
214+
[packages/kitsu-core/src/error/index.js:27-33](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/error/index.js#L27-L33 "Source code on GitHub")
215215

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

@@ -248,14 +248,14 @@ error({
248248

249249
### filterIncludes
250250

251-
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
251+
[packages/kitsu-core/src/filterIncludes/index.js:33-46](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/filterIncludes/index.js#L33-L46 "Source code on GitHub")
252252

253253
Filters includes for the specific relationship requested
254254

255255
#### Parameters
256256

257257
- `included` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>** The response included object
258-
- `relationship` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
258+
- `relationship` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
259259
- `relationship.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship ID
260260
- `relationship.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship type
261261

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

288288
### linkRelationships
289289

290-
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
290+
[packages/kitsu-core/src/linkRelationships/index.js:97-117](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/linkRelationships/index.js#L97-L117 "Source code on GitHub")
291291

292292
Links relationships to included data
293293

@@ -325,7 +325,7 @@ Returns **any** Parsed data
325325

326326
### query
327327

328-
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
328+
[packages/kitsu-core/src/query/index.js:33-44](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/query/index.js#L33-L44 "Source code on GitHub")
329329

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

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

354354
### serialise
355355

356-
[packages/kitsu-core/src/serialise/index.js:249-260](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/serialise/index.js#L249-L260 "Source code on GitHub")
356+
[packages/kitsu-core/src/serialise/index.js:210-221](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/serialise/index.js#L210-L221 "Source code on GitHub")
357357

358358
Serialises an object into a JSON-API structure
359359

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

400400
### splitModel
401401

402-
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
402+
[packages/kitsu-core/src/splitModel/index.js:29-39](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/splitModel/index.js#L29-L39 "Source code on GitHub")
403403

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

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

443443
### camel
444444

445-
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
445+
[packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub")
446446

447447
Converts kebab-case and snake_case into camelCase
448448

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

471471
### kebab
472472

473-
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
473+
[packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub")
474474

475475
Converts camelCase into kebab-case
476476

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

489489
### snake
490490

491-
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/3fcd88441936dfcec441faf3c5903c04c6c0c0cc/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
491+
[packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/fcd06d9b5338ab28637a564c3b770a96750ad00a/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub")
492492

493493
Converts camelCase into snake_case
494494

0 commit comments

Comments
 (0)