node-wget-fetch - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "node-wget-fetch",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Ultra simple async retrieval of resources or remote files over http or https, an cli tool, and convenience wrapper of node-fetch.",
   "main": "wget-fetch.js",
-  "types": "wget-fetch.d.ts",
   "scripts": {
@@ -8,0 +7,0 @@ "test": "mocha -R list test/*.js",

wget-fetch.js

@@ -321,11 +321,178 @@ 'use strict';
 
+/**
+ * Retrieve remote file over http or http
+ *
+ * @param {String} url Absolute url of source
+ * @param {Mixed} folderFilename Save to destination or use for options
+ * @param {Object} options Fetch/Request options
+ *
+ * @return {Promise} `Promise` info of completed file transfer:
+ * - { filepath: string, fileSize: number, retrievedSizeMatch: boolean, headers: object}
+ */
 fetching.wget = wget;
+
+/**
+ * Fetch the given `url` by header `GET` method
+ *
+ * @param url - URL string.
+ * @param responseType Response action type:
+    - 'header' for all response headers - raw()
+    - 'object' for the response object - no post/pre processing
+    - 'array' for arrayBuffer()
+    - 'buffer' for buffer()
+    - 'blob' for blob()
+    - 'json' for json()
+    - 'text' for text()
+    - 'converted' for textConverted()
+    - 'stream' for NodeJs.readableStream()
+ * @param options optional `Fetch` options.
+ * @returns A promise response of headers.
+ */
 fetching.get = verbFunc('get');
+
+/**
+ * Fetch the given `url` by header `HEAD` method
+ *
+ * @param url - URL string.
+ * @param responseType Response action type:
+    - 'header' for all response headers - raw()
+    - 'object' for the response object - no post/pre processing
+    - 'array' for arrayBuffer()
+    - 'buffer' for buffer()
+    - 'blob' for blob()
+    - 'json' for json()
+    - 'text' for text()
+    - 'converted' for textConverted()
+    - 'stream' for NodeJs.readableStream()
+ * @param options optional `Fetch` options.
+ * @returns A promise response of headers.
+ */
 fetching.head = verbFunc('head');
+
+/**
+ * Fetch the given `url` by header `OPTIONS` method
+ *
+ * @param url - URL string.
+ * @param responseType Response action type:
+    - 'header' for all response headers - raw()
+    - 'object' for the response object - no post/pre processing
+    - 'array' for arrayBuffer()
+    - 'buffer' for buffer()
+    - 'blob' for blob()
+    - 'json' for json()
+    - 'text' for text()
+    - 'converted' for textConverted()
+    - 'stream' for NodeJs.readableStream()
+ * @param options optional `Fetch` options.
+ * @returns A promise response of headers.
+ */
 fetching.options = verbFunc('options');
+
+/**
+ * Fetch the given `url` by header `POST` method
+ *
+ * @param url - URL string.
+ * @param body - Data to send.
+ * @param responseType Response action type:
+    - 'header' for all response headers - raw()
+    - 'object' for the response object - no post/pre processing
+    - 'array' for arrayBuffer()
+    - 'buffer' for buffer()
+    - 'blob' for blob()
+    - 'json' for json()
+    - 'text' for text()
+    - 'converted' for textConverted()
+    - 'stream' for NodeJs.readableStream()
+ * @param options optional `Fetch` options.
+ * @returns A promise response body of given response action type.
+ */
 fetching.post = verbFuncBody('post');
+
+/**
+ * Fetch the given `url` by header `PUT` method
+ *
+ * @param url - URL string.
+ * @param body - Data to send.
+ * @param responseType Response action type:
+    - 'header' for all response headers - raw()
+    - 'object' for the response object - no post/pre processing
+    - 'array' for arrayBuffer()
+    - 'buffer' for buffer()
+    - 'blob' for blob()
+    - 'json' for json()
+    - 'text' for text()
+    - 'converted' for textConverted()
+    - 'stream' for NodeJs.readableStream()
+ * @param options optional `Fetch` options.
+ * @returns A promise response body of given response action type.
+ */
 fetching.put = verbFuncBody('put');
+
+/**
+ * Fetch the given `url` by header `PATCH` method
+ *
+ * @param url - URL string.
+ * @param body - Data to send.
+ * @param responseType Response action type:
+    - 'header' for all response headers - raw()
+    - 'object' for the response object - no post/pre processing
+    - 'array' for arrayBuffer()
+    - 'buffer' for buffer()
+    - 'blob' for blob()
+    - 'json' for json()
+    - 'text' for text()
+    - 'converted' for textConverted()
+    - 'stream' for NodeJs.readableStream()
+ * @param options optional `Fetch` options.
+ * @returns A promise response body of given response action type.
+ */
 fetching.patch = verbFuncBody('patch');
+
+/**
+ * Fetch the given `url` by header `DELETE` method
+ *
+ * @param url - URL string.
+ * @param body - Data to send.
+ * @param responseType Response action type:
+    - 'header' for all response headers - raw()
+    - 'object' for the response object - no post/pre processing
+    - 'array' for arrayBuffer()
+    - 'buffer' for buffer()
+    - 'blob' for blob()
+    - 'json' for json()
+    - 'text' for text()
+    - 'converted' for textConverted()
+    - 'stream' for NodeJs.readableStream()
+ * @param options optional `Fetch` options.
+ * @returns A promise response body of given response action type.
+ */
 fetching.del = verbFuncBody('delete');
+
+/**
+ * Fetch the given `url` by header `DELETE` method
+ *
+ * @param url - URL string.
+ * @param body - Data to send.
+ * @param responseType Response action type:
+    - 'header' for all response headers - raw()
+    - 'object' for the response object - no post/pre processing
+    - 'array' for arrayBuffer()
+    - 'buffer' for buffer()
+    - 'blob' for blob()
+    - 'json' for json()
+    - 'text' for text()
+    - 'converted' for textConverted()
+    - 'stream' for NodeJs.readableStream()
+ * @param options optional `Fetch` options.
+ * @returns A promise response body of given response action type.
+ */
 fetching['delete'] = verbFuncBody('delete');
+
+/**
+ * Fetch function
+ *
+ * @param   Mixed    url   Absolute url or Request instance
+ * @param   Object   opts  Fetch options
+ * @return  Promise
+ */
 fetching.fetch = fetch;
@@ -332,0 +499,0 @@

No alert changes

Worsened metrics

Total package byte prevSize

25743

decreased by-4.57%

Number of package files

5

decreased by-16.67%

Lines of code

564

decreased by-0.35%

No dependency changes