http-call - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

http.js

@@ -25,3 +25,17 @@ const util = require('util')
 
+/**
+ * Utility for simple HTTP calls
+ * @class
+ */
 class HTTP {
+  /**
+   * make a simple http request
+   * @param url {string} - url or path to call
+   * @param options {object}
+   * @example
+   * ```js
+   * const http = require('http-call')
+   * await http.get('https://google.com')
+   * ```
+   */
   static get (url, options = {}) {
@@ -28,0 +42,0 @@ let http = new HTTP(Object.assign({}, options, {

package.json

 {
   "name": "http-call",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "make http requests",
@@ -18,3 +18,3 @@ "author": "Jeff Dickey @dickeyxxx",
   "scripts": {
-    "doc": "jsdoc2md --template README.hbs --files rwlockfile.js > README.md",
+    "doc": "jsdoc2md --template README.hbs --files http.js > README.md",
     "test": "standard",
@@ -21,0 +21,0 @@ "version": "npm run doc && git add README.md"

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

101919

increased by1.43%

Number of package files

6

increased by20%

Lines of code

137

increased by11.38%

Number of lines in readme file

34

increased by3300%

No dependency changes