diff --git a/package.json b/package.json index 81707c6..d2d4d79 100644 --- a/package.json +++ b/package.json @@ -34,15 +34,15 @@ }, "license": "MIT", "dependencies": { + "@achingbrain/electron-fetch": "^1.7.2", "abort-controller": "^3.0.0", "any-signal": "^2.1.0", - "buffer": "^5.6.0", - "@achingbrain/electron-fetch": "^1.7.2", + "buffer": "^6.0.1", "err-code": "^2.0.0", "fs-extra": "^9.0.1", "is-electron": "^2.2.0", - "iso-url": "^0.4.7", - "it-glob": "0.0.8", + "iso-url": "^1.0.0", + "it-glob": "0.0.10", "merge-options": "^2.0.0", "nanoid": "^3.1.3", "native-abort-controller": "0.0.3", @@ -51,7 +51,7 @@ "stream-to-it": "^0.2.0" }, "devDependencies": { - "aegir": "^25.0.0", + "aegir": "^28.1.0", "delay": "^4.3.0", "it-all": "^1.0.2", "it-drain": "^1.0.1", diff --git a/src/files/glob-source.js b/src/files/glob-source.js index 8a3d3d4..29a6eb5 100644 --- a/src/files/glob-source.js +++ b/src/files/glob-source.js @@ -6,20 +6,20 @@ const Path = require('path') const errCode = require('err-code') /** -* Create an async iterator that yields paths that match requested file paths. -* -* @param {Iterable|AsyncIterable|String} paths File system path(s) to glob from -* @param {Object} [options] Optional options -* @param {Boolean} [options.recursive] Recursively glob all paths in directories -* @param {Boolean} [options.hidden] Include .dot files in matched paths -* @param {Array} [options.ignore] Glob paths to ignore -* @param {Boolean} [options.followSymlinks] follow symlinks -* @param {Boolean} [options.preserveMode] preserve mode -* @param {Boolean} [options.preserveMtime] preserve mtime -* @param {Boolean} [options.mode] mode to use - if preserveMode is true this will be ignored -* @param {Boolean} [options.mtime] mtime to use - if preserveMtime is true this will be ignored -* @yields {Object} File objects in the form `{ path: String, content: AsyncIterator }` -*/ + * Create an async iterator that yields paths that match requested file paths. + * + * @param {Iterable | AsyncIterable | string} paths - File system path(s) to glob from + * @param {Object} [options] - Optional options + * @param {boolean} [options.recursive] - Recursively glob all paths in directories + * @param {boolean} [options.hidden] - Include .dot files in matched paths + * @param {Array} [options.ignore] - Glob paths to ignore + * @param {boolean} [options.followSymlinks] - follow symlinks + * @param {boolean} [options.preserveMode] - preserve mode + * @param {boolean} [options.preserveMtime] - preserve mtime + * @param {boolean} [options.mode] - mode to use - if preserveMode is true this will be ignored + * @param {boolean} [options.mtime] - mtime to use - if preserveMtime is true this will be ignored + * @yields {Object} File objects in the form `{ path: String, content: AsyncIterator }` + */ module.exports = async function * globSource (paths, options) { options = options || {} diff --git a/src/http.js b/src/http.js index 6eaaa76..7c3a423 100644 --- a/src/http.js +++ b/src/http.js @@ -75,19 +75,19 @@ const defaults = { /** * @typedef {Object} APIOptions - creates a new type named 'SpecialType' - * @prop {any} [body] - Request body - * @prop {Object} [json] - JSON shortcut - * @prop {string} [method] - GET, POST, PUT, DELETE, etc. - * @prop {string} [base] - The base URL to use in case url is a relative URL - * @prop {Headers|Record} [headers] - Request header. - * @prop {number} [timeout] - Amount of time until request should timeout in ms. - * @prop {AbortSignal} [signal] - Signal to abort the request. - * @prop {URLSearchParams|Object} [searchParams] - URL search param. - * @prop {string} [credentials] - * @prop {boolean} [throwHttpErrors] - * @prop {function(URLSearchParams): URLSearchParams } [transformSearchParams] - * @prop {function(any): any} [transform] - When iterating the response body, transform each chunk with this function. - * @prop {function(Response): Promise} [handleError] - Handle errors + * @property {any} [body] - Request body + * @property {Object} [json] - JSON shortcut + * @property {string} [method] - GET, POST, PUT, DELETE, etc. + * @property {string} [base] - The base URL to use in case url is a relative URL + * @property {Headers|Record} [headers] - Request header. + * @property {number} [timeout] - Amount of time until request should timeout in ms. + * @property {AbortSignal} [signal] - Signal to abort the request. + * @property {URLSearchParams|Object} [searchParams] - URL search param. + * @property {string} [credentials] + * @property {boolean} [throwHttpErrors] + * @property {function(URLSearchParams): URLSearchParams } [transformSearchParams] + * @property {function(any): any} [transform] - When iterating the response body, transform each chunk with this function. + * @property {function(Response): Promise} [handleError] - Handle errors */ class HTTP {