Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
kitsu-core
Advanced tools
kitsu-core - npm Package Compare versions
Comparing version 6.3.0 to 6.3.1
@@ -6,2 +6,18 @@ # Change Log | ||
| ## [6.3.1](https://github.com/wopian/kitsu/tree/master/packages/kitsu-core/compare/kitsu-core@6.3.0...kitsu-core@6.3.1) (2018-08-31) | ||
| ### Chores | ||
| * **release:** update documentation ([4fd20c5](https://github.com/wopian/kitsu/tree/master/packages/kitsu-core/commit/4fd20c5)) | ||
| ### Documentation Changes | ||
| * **kitsu-core:** mark internal functions as private ([7d8cff1](https://github.com/wopian/kitsu/tree/master/packages/kitsu-core/commit/7d8cff1)) | ||
| <a name="6.3.0"></a> | ||
@@ -8,0 +24,0 @@ # 6.3.0 (2018-08-29) |
| { | ||
| "version": "6.3.0", | ||
| "version": "6.3.1", | ||
| "name": "kitsu-core", | ||
@@ -59,3 +59,3 @@ "description": "Core serialisation and deserialsation functions for the kitsu JSON:API client", | ||
| ], | ||
| "gitHead": "3c84631ef4925bbb472b10cbb9ae57ac2ac03017" | ||
| "gitHead": "52c4b5d9c8750f327f0febb5dac19f1155b0d95d" | ||
| } |
@@ -95,19 +95,15 @@ <h1 align=center>Kitsu Core</h1> | ||
| - [Parameters](#parameters-4) | ||
| - [queryFormat](#queryformat) | ||
| - [query](#query) | ||
| - [Parameters](#parameters-5) | ||
| - [query](#query) | ||
| - [serialise](#serialise) | ||
| - [Parameters](#parameters-6) | ||
| - [isValid](#isvalid) | ||
| - [Parameters](#parameters-7) | ||
| - [serialise](#serialise) | ||
| - [Parameters](#parameters-8) | ||
| - [Examples](#examples-2) | ||
| - [camel](#camel) | ||
| - [Parameters](#parameters-9) | ||
| - [Parameters](#parameters-7) | ||
| - [Examples](#examples-3) | ||
| - [kebab](#kebab) | ||
| - [Parameters](#parameters-10) | ||
| - [Parameters](#parameters-8) | ||
| - [Examples](#examples-4) | ||
| - [snake](#snake) | ||
| - [Parameters](#parameters-11) | ||
| - [Parameters](#parameters-9) | ||
| - [Examples](#examples-5) | ||
@@ -117,3 +113,3 @@ | ||
| [packages/kitsu-core/src/deattribute/index.js:29-38](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/deattribute/index.js#L29-L38 "Source code on GitHub") | ||
| [packages/kitsu-core/src/deattribute/index.js:29-38](https://github.com/wopian/kitsu/blob/7d8cff1b0d8f79da6adba9dbbaa056251f1e7f41/packages/kitsu-core/src/deattribute/index.js#L29-L38 "Source code on GitHub") | ||
@@ -160,3 +156,3 @@ Hoists attributes to be top-level | ||
| [packages/kitsu-core/src/deserialise/index.js:56-70](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/deserialise/index.js#L56-L70 "Source code on GitHub") | ||
| [packages/kitsu-core/src/deserialise/index.js:56-70](https://github.com/wopian/kitsu/blob/7d8cff1b0d8f79da6adba9dbbaa056251f1e7f41/packages/kitsu-core/src/deserialise/index.js#L56-L70 "Source code on GitHub") | ||
@@ -211,3 +207,3 @@ Deserialises a JSON-API response | ||
| [packages/kitsu-core/src/error/index.js:7-13](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/error/index.js#L7-L13 "Source code on GitHub") | ||
| [packages/kitsu-core/src/error/index.js:7-13](https://github.com/wopian/kitsu/blob/7d8cff1b0d8f79da6adba9dbbaa056251f1e7f41/packages/kitsu-core/src/error/index.js#L7-L13 "Source code on GitHub") | ||
@@ -225,3 +221,3 @@ Mutates an error and rethrows it | ||
| [packages/kitsu-core/src/filterIncludes/index.js:12-21](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/filterIncludes/index.js#L12-L21 "Source code on GitHub") | ||
| [packages/kitsu-core/src/filterIncludes/index.js:12-21](https://github.com/wopian/kitsu/blob/7d8cff1b0d8f79da6adba9dbbaa056251f1e7f41/packages/kitsu-core/src/filterIncludes/index.js#L12-L21 "Source code on GitHub") | ||
@@ -241,3 +237,3 @@ Filters includes for the specific relationship | ||
| [packages/kitsu-core/src/linkRelationships/index.js:55-74](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/linkRelationships/index.js#L55-L74 "Source code on GitHub") | ||
| [packages/kitsu-core/src/linkRelationships/index.js:55-74](https://github.com/wopian/kitsu/blob/7d8cff1b0d8f79da6adba9dbbaa056251f1e7f41/packages/kitsu-core/src/linkRelationships/index.js#L55-L74 "Source code on GitHub") | ||
@@ -251,18 +247,5 @@ Links relationships to included data | ||
| ### queryFormat | ||
| [packages/kitsu-core/src/query/index.js:8-11](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/query/index.js#L8-L11 "Source code on GitHub") | ||
| Formats a single URL query | ||
| #### Parameters | ||
| - `value` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Right-hand side of the query | ||
| - `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Left-hand side of the query | ||
| Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** URL query string | ||
| ### query | ||
| [packages/kitsu-core/src/query/index.js:20-31](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/query/index.js#L20-L31 "Source code on GitHub") | ||
| [packages/kitsu-core/src/query/index.js:21-32](https://github.com/wopian/kitsu/blob/7d8cff1b0d8f79da6adba9dbbaa056251f1e7f41/packages/kitsu-core/src/query/index.js#L21-L32 "Source code on GitHub") | ||
@@ -278,17 +261,5 @@ Constructs a URL query string for JSON:API parameters | ||
| ### isValid | ||
| [packages/kitsu-core/src/serialise/index.js:11-20](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/serialise/index.js#L11-L20 "Source code on GitHub") | ||
| Checks if data is valid for serialisation | ||
| #### Parameters | ||
| - `obj` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The data | ||
| - `method` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Request type | ||
| - `type` | ||
| ### serialise | ||
| [packages/kitsu-core/src/serialise/index.js:67-92](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/serialise/index.js#L67-L92 "Source code on GitHub") | ||
| [packages/kitsu-core/src/serialise/index.js:96-121](https://github.com/wopian/kitsu/blob/7d8cff1b0d8f79da6adba9dbbaa056251f1e7f41/packages/kitsu-core/src/serialise/index.js#L96-L121 "Source code on GitHub") | ||
@@ -318,3 +289,3 @@ Serialises an object into a JSON-API structure | ||
| [packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub") | ||
| [packages/kitsu-core/src/camel/index.js:14-14](https://github.com/wopian/kitsu/blob/7d8cff1b0d8f79da6adba9dbbaa056251f1e7f41/packages/kitsu-core/src/camel/index.js#L14-L14 "Source code on GitHub") | ||
@@ -345,3 +316,3 @@ Converts kebab-case and snake_case into camelCase | ||
| [packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub") | ||
| [packages/kitsu-core/src/kebab/index.js:11-11](https://github.com/wopian/kitsu/blob/7d8cff1b0d8f79da6adba9dbbaa056251f1e7f41/packages/kitsu-core/src/kebab/index.js#L11-L11 "Source code on GitHub") | ||
@@ -364,3 +335,3 @@ Converts camelCase into kebab-case | ||
| [packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/77a568d003a49a776c5eedd684e865b112a9af93/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub") | ||
| [packages/kitsu-core/src/snake/index.js:11-11](https://github.com/wopian/kitsu/blob/7d8cff1b0d8f79da6adba9dbbaa056251f1e7f41/packages/kitsu-core/src/snake/index.js#L11-L11 "Source code on GitHub") | ||
@@ -367,0 +338,0 @@ Converts camelCase into snake_case |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.9%
93823
- Number of lines in readme file
- decreased by-7.42%
362
No dependency changes