Merge pull request #10 from EdamAme-x/jsdoc-http-exception

Jsdoc http exception
EdamAme-x · May 30, 2024 · 5e1af0f · 5e1af0f
2 parents f2ff88a + 482d302
commit 5e1af0f
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/src/http-exception.ts b/src/http-exception.ts
@@ -13,6 +13,15 @@ type HTTPExceptionOptions = {
 
 /**
  * `HTTPException` must be used when a fatal error such as authentication failure occurs.
+ *
+ * @see {@link https://hono.dev/api/exception}
+ *
+ * @param {StatusCode} status - status code of HTTPException
+ * @param {HTTPExceptionOptions} options - options of HTTPException
+ * @param {HTTPExceptionOptions["res"]} options.res - response of options of HTTPException
+ * @param {HTTPExceptionOptions["message"]} options.message - message of options of HTTPException
+ * @param {HTTPExceptionOptions["cause"]} options.cause - cause of options of HTTPException
+ *
  * @example
  * ```ts
  * import { HTTPException } from 'hono/http-exception'
@@ -27,7 +36,6 @@ type HTTPExceptionOptions = {
  *   await next()
  * })
  * ```
- * @see https://hono.dev/api/exception
  */
 export class HTTPException extends Error {
   readonly res?: Response