Merge pull request #3 from EdamAme-x/jsdoc-on-error

Jsdoc on error
EdamAme-x · May 28, 2024 · 25f10d9 · 25f10d9
2 parents 05e6f60 + a903386
commit 25f10d9
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/hono-base.ts b/src/hono-base.ts
@@ -223,6 +223,13 @@ class Hono<E extends Env = Env, S extends Schema = {}, BasePath extends string =
 
   /**
    * `.onError()` handles an error and returns a customized Response.
+   *
+   * @see {@link https://hono.dev/api/hono#error-handling}
+   *
+   * @param {ErrorHandler} handler - request Handler for error
+   * @returns {Hono} changed Hono instance
+   *
+   * @example
    * ```ts
    * app.onError((err, c) => {
    *   console.error(`${err}`)