Basic Authentication Middleware

deno_dist/middleware/basic-auth/index.ts

@@ -40,6 +40,37 @@ type BasicAuthOptions =
       hashFunction?: Function
     }
 
+/**
+ * Basic authentication middleware for Hono.
+ *
+ * @see {@link https://hono.dev/middleware/builtin/basic-auth}
+ *
+ * @param {BasicAuthOptions} options - The options for the basic authentication middleware.
+ * @param {string} [options.username] - The username for authentication.
+ * @param {string} [options.password] - The password for authentication.
+ * @param {string} [options.realm="Secure Area"] - The realm attribute for the WWW-Authenticate header.
+ * @param {Function} [options.hashFunction=] - The hash function used for secure comparison.
+ * @param {Function} [options.verifyUser=] - The function to verify user credentials.
+ * @returns {MiddlewareHandler} - The middleware handler function.
+ * @throws {HTTPException} If neither "username and password" nor "verifyUser" options are provided.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ *
+ * app.use(
+ *   '/auth/*',
+ *   basicAuth({
+ *     username: 'hono',
+ *     password: 'acoolproject',
+ *   })
+ * )
+ *
+ * app.get('/auth/page', (c) => {
+ *   return c.text('You are authorized')
+ * })
+ * ```
+ */
 export const basicAuth = (
   options: BasicAuthOptions,
   ...users: { username: string; password: string }[]

src/middleware/basic-auth/index.ts

@@ -40,6 +40,37 @@ type BasicAuthOptions =
       hashFunction?: Function
     }
 
+/**
+ * Basic authentication middleware for Hono.
+ *
+ * @see {@link https://hono.dev/middleware/builtin/basic-auth}
+ *
+ * @param {BasicAuthOptions} options - The options for the basic authentication middleware.
+ * @param {string} [options.username] - The username for authentication.
+ * @param {string} [options.password] - The password for authentication.
+ * @param {string} [options.realm="Secure Area"] - The realm attribute for the WWW-Authenticate header.
+ * @param {Function} [options.hashFunction=] - The hash function used for secure comparison.
+ * @param {Function} [options.verifyUser=] - The function to verify user credentials.
+ * @returns {MiddlewareHandler} - The middleware handler function.
+ * @throws {HTTPException} If neither "username and password" nor "verifyUser" options are provided.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ *
+ * app.use(
+ *   '/auth/*',
+ *   basicAuth({
+ *     username: 'hono',
+ *     password: 'acoolproject',
+ *   })
+ * )
+ *
+ * app.get('/auth/page', (c) => {
+ *   return c.text('You are authorized')
+ * })
+ * ```
+ */
 export const basicAuth = (
   options: BasicAuthOptions,
   ...users: { username: string; password: string }[]