Skip to content

chore(index): add jsdoc types #177

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

Merged
Fdawgs merged 1 commit into from
Nov 28, 2025
Merged

chore(index): add jsdoc types #177

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
10 changes: 10 additions & 0 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
const fp = require('fastify-plugin')
const createError = require('@fastify/error')

/** @typedef {import('./types/index').FastifyBasicAuthOptions} FastifyBasicAuthOptions */

/**
* HTTP provides a simple challenge-response authentication framework
* that can be used by a server to challenge a client request and by a
Expand Down Expand Up @@ -59,6 +61,7 @@ const controlRE = /[\x00-\x1F\x7F]/

const userPassRE = /^([^:]*):(.*)$/

/** @type {typeof import('./types/index').fastifyBasicAuth} */
async function fastifyBasicAuth (fastify, opts) {
if (typeof opts.validate !== 'function') {
throw new Error('Basic Auth: Missing validate function')
Expand Down Expand Up @@ -144,6 +147,13 @@ async function fastifyBasicAuth (fastify, opts) {
}
}

/**
* Generates a function that returns the appropriate authentication header.
* @param {FastifyBasicAuthOptions['authenticate']} authenticate - The authenticate option.
* @param {FastifyBasicAuthOptions['utf8']} useUtf8 - Whether to use UTF-8 charset.
* @param {FastifyBasicAuthOptions['proxyMode']} proxyMode - Whether in proxy mode.
* @returns {(req: import('fastify').FastifyRequest) => false | [string, string]} Function that returns header tuple or false.
*/
function getAuthenticateHeaders (authenticate, useUtf8, proxyMode) {
const defaultHeaderName = proxyMode ? 'Proxy-Authenticate' : 'WWW-Authenticate'
if (!authenticate) return () => false
Expand Down
Loading