kitsu - npm Package Compare versions

Comparing version 9.0.2 to 9.0.3

CHANGELOG.md

@@ -6,2 +6,18 @@ # Change Log
 
+## [9.0.3](https://github.com/wopian/kitsu/tree/master/packages/kitsu/compare/v9.0.2...v9.0.3) (2020-05-07)
+
+
+### Chores
+
+* **release:** update documentation ([95c3fbb](https://github.com/wopian/kitsu/tree/master/packages/kitsu/commit/95c3fbb))
+
+
+### Documentation Changes
+
+* **kitsu:** add JSON:API query parameters to Quick Start ([a5c501a](https://github.com/wopian/kitsu/tree/master/packages/kitsu/commit/a5c501a))
+
+
+
+
+
 ## [9.0.2](https://github.com/wopian/kitsu/tree/master/packages/kitsu/compare/v9.0.1...v9.0.2) (2020-05-07)
@@ -8,0 +24,0 @@

package.json

 {
-  "version": "9.0.2",
+  "version": "9.0.3",
   "name": "kitsu",
@@ -50,3 +50,3 @@ "description": "Simple & lightweight JSON-API client for Kitsu and other compliant APIs",
     "axios": "^0.19.0",
-    "kitsu-core": "^9.0.2",
+    "kitsu-core": "^9.0.3",
     "pluralize": "^8.0.0"
@@ -64,3 +64,3 @@ },
   ],
-  "gitHead": "b6ca7b2435a78b2338afad68fade3d90f18dc5e6",
+  "gitHead": "5a805eedbea41921e161a7111eda595900818d80",
   "devDependencies": {
@@ -67,0 +67,0 @@ "@size-limit/preset-small-lib": "~4.5.0"

README.md

@@ -158,2 +158,18 @@ <h1 align=center>Kitsu</h1>
 api.remove('post', 1)
+
+// JSON:API parameters
+api.get('users', {
+  include: 'followers,waifu.character',
+  fields: {
+    users: 'slug,followers,waifu'
+  }
+  filter: {
+    slug: 'wopian'
+  }
+  sort: '-id',
+  page: {
+    limit: 5,
+    offset: 0
+  }
+})
 ```
@@ -198,3 +214,3 @@
 
-[packages/kitsu/src/index.js:30-342](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu/src/index.js#L30-L342 "Source code on GitHub")
+[packages/kitsu/src/index.js:30-342](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu/src/index.js#L30-L342 "Source code on GitHub")
 
@@ -246,3 +262,3 @@ Creates a new `kitsu` instance
 
-[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
+[packages/kitsu/src/index.js:52-53](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu/src/index.js#L52-L53 "Source code on GitHub")
 
@@ -269,3 +285,3 @@ -   **See: <https://www.npmjs.com/package/pluralize> for documentation
 
-[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
+[packages/kitsu/src/index.js:67-67](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu/src/index.js#L67-L67 "Source code on GitHub")
 
@@ -301,3 +317,3 @@ Get the current headers or add additional headers
 
-[packages/kitsu/src/index.js:111-111](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu/src/index.js#L111-L111 "Source code on GitHub")
+[packages/kitsu/src/index.js:111-111](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu/src/index.js#L111-L111 "Source code on GitHub")
 
@@ -350,3 +366,3 @@ Axios Interceptors (alias of `axios.interceptors`)
 
-[packages/kitsu/src/index.js:184-203](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu/src/index.js#L184-L203 "Source code on GitHub")
+[packages/kitsu/src/index.js:184-203](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu/src/index.js#L184-L203 "Source code on GitHub")
 
@@ -463,3 +479,3 @@ Fetch resources (alias `fetch`)
 
-[packages/kitsu/src/index.js:219-239](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu/src/index.js#L219-L239 "Source code on GitHub")
+[packages/kitsu/src/index.js:219-239](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu/src/index.js#L219-L239 "Source code on GitHub")
 
@@ -490,3 +506,3 @@ Update a resource (alias `update`)
 
-[packages/kitsu/src/index.js:262-281](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu/src/index.js#L262-L281 "Source code on GitHub")
+[packages/kitsu/src/index.js:262-281](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu/src/index.js#L262-L281 "Source code on GitHub")
 
@@ -524,3 +540,3 @@ Create a new resource (alias `create`)
 
-[packages/kitsu/src/index.js:294-312](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu/src/index.js#L294-L312 "Source code on GitHub")
+[packages/kitsu/src/index.js:294-312](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu/src/index.js#L294-L312 "Source code on GitHub")
 
@@ -548,3 +564,3 @@ Remove a resource (alias `remove`)
 
-[packages/kitsu/src/index.js:334-341](https://github.com/wopian/kitsu/blob/1fc81d9f704d91002b638bf3483fdd4e8f1812f1/packages/kitsu/src/index.js#L334-L341 "Source code on GitHub")
+[packages/kitsu/src/index.js:334-341](https://github.com/wopian/kitsu/blob/a5c501adbeffe96ad8ea7596a9a9e5511cebca72/packages/kitsu/src/index.js#L334-L341 "Source code on GitHub")
 
@@ -551,0 +567,0 @@ Get the authenticated user's data

New alerts

License Policy Violation

License

This 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

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

90149

increased by0.73%

Number of lines in readme file

621

increased by2.64%

Dependency changes

• Updatedkitsu-core@^9.0.3