From f43d7987c1f452c8ba7dbef332a998c2266f8605 Mon Sep 17 00:00:00 2001 From: RatchetS2 <19169837+RatchetS2@users.noreply.github.com> Date: Thu, 18 Sep 2025 12:21:52 +0000 Subject: [PATCH] Update JSDoc --- index.js | 31 ++++++++++++------------------- 1 file changed, 12 insertions(+), 19 deletions(-) diff --git a/index.js b/index.js index 4f2840c..45c07fe 100644 --- a/index.js +++ b/index.js @@ -28,7 +28,6 @@ module.exports = Accepts * @param {object} req * @public */ - function Accepts (req) { if (!(this instanceof Accepts)) { return new Accepts(req) @@ -74,11 +73,10 @@ function Accepts (req) { * this.types('html', 'json'); * // => "json" * - * @param {String|Array} types... - * @return {String|Array|Boolean} + * @param {...string|string[]} types_ + * @return {string|string[]|false} * @public */ - Accepts.prototype.type = Accepts.prototype.types = function (types_) { var types = types_ @@ -118,11 +116,10 @@ Accepts.prototype.types = function (types_) { * * ['gzip', 'deflate'] * - * @param {String|Array} encodings... - * @return {String|Array} + * @param {...string|string[]} encodings_ + * @return {string|string[]|false} * @public */ - Accepts.prototype.encoding = Accepts.prototype.encodings = function (encodings_) { var encodings = encodings_ @@ -151,11 +148,10 @@ Accepts.prototype.encodings = function (encodings_) { * * ['utf-8', 'utf-7', 'iso-8859-1'] * - * @param {String|Array} charsets... - * @return {String|Array} + * @param {...string|string[]} charsets_ + * @return {string|string[]|false} * @public */ - Accepts.prototype.charset = Accepts.prototype.charsets = function (charsets_) { var charsets = charsets_ @@ -184,11 +180,10 @@ Accepts.prototype.charsets = function (charsets_) { * * ['es', 'pt', 'en'] * - * @param {String|Array} langs... - * @return {Array|String} + * @param {...string|string[]} languages_ + * @return {string|string[]|false} * @public */ - Accepts.prototype.lang = Accepts.prototype.langs = Accepts.prototype.language = @@ -214,11 +209,10 @@ Accepts.prototype.languages = function (languages_) { /** * Convert extnames to mime. * - * @param {String} type - * @return {String} + * @param {string} type + * @return {string} * @private */ - function extToMime (type) { return type.indexOf('/') === -1 ? mime.lookup(type) @@ -228,11 +222,10 @@ function extToMime (type) { /** * Check if mime is valid. * - * @param {String} type - * @return {Boolean} + * @param {string} type + * @return {boolean} * @private */ - function validMime (type) { return typeof type === 'string' }