docs(jsdoc): Logger Middleware (honojs#2708)

code · May 24, 2024 · f696888 · f696888
1 parent 8645b64
commit f696888
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/deno_dist/middleware/logger/index.ts b/deno_dist/middleware/logger/index.ts
@@ -55,6 +55,22 @@ function log(
   fn(out)
 }
 
+/**
+ * Logger middleware for Hono.
+ *
+ * @see {@link https://hono.dev/middleware/builtin/logger}
+ *
+ * @param {PrintFunc} [fn=console.log] - Optional function for customized logging behavior.
+ * @returns {MiddlewareHandler} The middleware handler function.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ *
+ * app.use(logger())
+ * app.get('/', (c) => c.text('Hello Hono!'))
+ * ```
+ */
 export const logger = (fn: PrintFunc = console.log): MiddlewareHandler => {
   return async function logger(c, next) {
     const { method } = c.req

diff --git a/src/middleware/logger/index.ts b/src/middleware/logger/index.ts
@@ -55,6 +55,22 @@ function log(
   fn(out)
 }
 
+/**
+ * Logger middleware for Hono.
+ *
+ * @see {@link https://hono.dev/middleware/builtin/logger}
+ *
+ * @param {PrintFunc} [fn=console.log] - Optional function for customized logging behavior.
+ * @returns {MiddlewareHandler} The middleware handler function.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ *
+ * app.use(logger())
+ * app.get('/', (c) => c.text('Hello Hono!'))
+ * ```
+ */
 export const logger = (fn: PrintFunc = console.log): MiddlewareHandler => {
   return async function logger(c, next) {
     const { method } = c.req