File tree Expand file tree Collapse file tree 1 file changed +9
-8
lines changed Expand file tree Collapse file tree 1 file changed +9
-8
lines changed Original file line number Diff line number Diff line change @@ -20,15 +20,16 @@ doxdox also features support for extendibility via custom plugins for both parsi
20
20
21
21
``` javascript
22
22
/**
23
- * Finds package.json from either the directory the script was called from or a supplied path .
23
+ * Request content from URL or array of URLs .
24
24
*
25
- * console.log(await findFileInPath('./'));
26
- * console.log(await findFileInPath('./package.json'));
27
- * console.log(await findFileInPath('~/git/github/doxdox/'));
28
- *
29
- * @param {string} [input] Directory to check for file.
30
- * @param {string?} [fileName = ' package.json' ] File name to check for.
31
- * @return {Promise<string | null>} Path to package.json file.
25
+ * @example fetch (' http://www.google.com/humans.txt' ).then (content => console .log (content));
26
+ * @example fetch ([' http://www.google.com/humans.txt' ]).then (contents => console .log (content[0 ]));
27
+ * @param {String|String[]} urls A URL or an array of URL strings.
28
+ * @param {Object} [options] Options object.
29
+ * @param {String} [options.cacheDirectory] Directory to store cache. Default is `temp/cache/`.
30
+ * @param {Object} [options.requestOptions] Custom request options object. Default is `{}`.
31
+ * @param {Number} [options.ttl] TTL (Time to live) in seconds. Default is 1800
32
+ * @return {Promise<String[]>} Contents of request as an array.
32
33
* @public
33
34
*/
34
35
```
You can’t perform that action at this time.
0 commit comments