cloudsight - npm Package Compare versions

Comparing version 1.1.2 to 1.1.3

CHANGELOG.md

@@ -0,1 +1,18 @@
+#### 1.1.3 (2017-12-12)
+
+##### Chores
+
+* **package:**
+  * Update httpreq dependency ([fa9d777e](https://github.com/fvdm/nodejs-cloudsight/commit/fa9d777e95cdcfc49be612fa8bc0ff1db04bae95))
+  * Reduce dev deps to dotest ([d2c9a436](https://github.com/fvdm/nodejs-cloudsight/commit/d2c9a436bf8c07c62ad186e82d74634cb7d22e05))
+  * update eslint to version 4.1.0 ([09017181](https://github.com/fvdm/nodejs-cloudsight/commit/090171810b9ee854192829146c8d946104e57cf4))
+
+##### Code Style Changes
+
+* **main:** Rewrite JSDoc comments ([8fdc2d1e](https://github.com/fvdm/nodejs-cloudsight/commit/8fdc2d1ea69df283bf6502a21914e1d82821ca49))
+
+##### Tests
+
+* **config:** Update Travis CI node versions ([4176cc7b](https://github.com/fvdm/nodejs-cloudsight/commit/4176cc7b561a0eb662ae278725b6c052f01f1d77))
+
 #### 1.1.2 (2017-4-4)
@@ -2,0 +19,0 @@

index.js

@@ -22,5 +22,3 @@ /*
  *
- * @param parts {number=8} - Number of parts to generate
- * @param prefix {string=-} - Prefix parts with string
- * @returns {string}
+ * @return  {string}
  */
@@ -44,5 +42,5 @@
  * @callback callback
- * @param {Error, null} err - Error
- * @param {object} res - Response data
- * @param {function} callback - `function (err, data) {}`
+ * @param  {Error|null}  err       Error
+ * @param  {object}      res       Response data
+ * @param  {function}    callback  `(err, data)`
  */
@@ -92,10 +90,10 @@
  *
- * @param {object} props
- * @param {string) props.path - i.e. /image_requests/token
- * @param {string} [props.method=GET] - GET or POST
- * @param {object} [props.data] - Data fields to send
- * @param {string} [props.endpoint = config.endpoint] - API endpoint override
- * @param {number} [props.timeout = config.timeout] - Request timeout override
- * @param {function} callback - Process response
- * @returns {void}
+ * @param   {object}    props
+ * @param   {string}    props.path            i.e. /image_requests/token
+ * @param   {string}    [props.method=GET]    GET or POST
+ * @param   {object}    [props.data]          Data fields to send
+ * @param   {string}    [props.endpoint]      API endpoint override
+ * @param   {number}    [props.timeout=5000]  Request timeout override
+ * @param   {function}  callback              Process response
+ * @return  {void}
  */
@@ -128,5 +126,5 @@
  *
- * @param {string} token - Image token
- * @param {function} callback
- * @returns {void}
+ * @param   {string}    token     Image token
+ * @param   {function}  callback
+ * @return  {void}
  */
@@ -147,5 +145,5 @@
  *
- * @param {string} token - Image token
- * @param {function} callback
- * @returns {void}
+ * @param   {string}    token     Image token
+ * @param   {function}  callback
+ * @return  {void}
  */
@@ -175,6 +173,6 @@
  *
- * @param {object} props - See README.md
- * @param {boolean} [polling=false] - Callback only when ready
- * @param {function} callback - Callback response
- * @returns {void}
+ * @param   {object}    props            See README.md
+ * @param   {boolean}   [polling=false]  Callback only when ready
+ * @param   {function}  callback         Callback response
+ * @return  {void}
  */
@@ -250,7 +248,7 @@
  *
- * @param {object} conf
- * @param {string} conf.apikey - Account API key
- * @param {string} [conf.endpoint] - Override API endpoint
- * @param {number} [conf.timeout=5000] - Override request timeout
- * @returns {object} - Module methods
+ * @param   {object}  conf
+ * @param   {string}  conf.apikey          Account API key
+ * @param   {string}  [conf.endpoint]      Override API endpoint
+ * @param   {number}  [conf.timeout=5000]  Override request timeout
+ * @return  {object}                       Module methods
  */
@@ -257,0 +255,0 @@

package.json

@@ -9,3 +9,3 @@ {
   "description": "CloudSight image recognition API (unofficial)",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "repository": {
@@ -23,9 +23,6 @@ "type": "git",
   "dependencies": {
-    "httpreq": "^0.4.23"
+    "httpreq": "^0.4.24"
   },
   "devDependencies": {
-    "coveralls": "^2.13.0",
-    "dotest": "^2.0.0",
-    "eslint": "^3.19.0",
-    "istanbul": "^0.4.5"
+    "dotest": "^2.1.0"
   },
@@ -32,0 +29,0 @@ "engines": {

README.md

@@ -9,2 +9,3 @@ cloudsight
 [![Dependency Status](https://gemnasium.com/badges/github.com/fvdm/nodejs-cloudsight.svg)](https://gemnasium.com/github.com/fvdm/nodejs-cloudsight#runtime-dependencies)
+[![Greenkeeper badge](https://badges.greenkeeper.io/fvdm/nodejs-cloudsight.svg)](https://greenkeeper.io/)
 
@@ -11,0 +12,0 @@ * [Node.js](https://nodejs.org/)

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

17730

increased by4.92%

Dev dependency count

1

decreased by-75%

Number of lines in readme file

165

increased by0.61%

Worsened metrics

Lines of code

214

decreased by-0.93%

Dependency changes

• Updatedhttpreq@^0.4.24