Skip to content

Update JSDoc #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update JSDoc #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 12 additions & 19 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ module.exports = Accepts
* @param {object} req
* @public
*/

function Accepts (req) {
if (!(this instanceof Accepts)) {
return new Accepts(req)
Expand Down Expand Up @@ -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_
Expand Down Expand Up @@ -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_
Expand Down Expand Up @@ -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_
Expand Down Expand Up @@ -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 =
Expand All @@ -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)
Expand All @@ -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'
}