chore: update jsdoc (#47)

maou-shonen · Nov 5, 2024 · 670f783 · 670f783
1 parent 08ac7b3
commit 670f783
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/src/logger.ts b/src/logger.ts
@@ -3,7 +3,7 @@ import defu from "defu";
 import { pino } from "pino";
 
 /**
- * hono-pino logger
+ * hono-pino logger instance
  */
 export interface PinoLogger {
   /**

diff --git a/src/middleware.ts b/src/middleware.ts
@@ -7,7 +7,7 @@ import { httpCfgSym, PinoLogger } from "./logger";
 import type { LiteralString } from "./utils";
 
 /**
- * Pino logger middleware
+ * hono-pino middleware
  */
 export const pinoLogger = <ContextKey extends string = "logger">(
   opts?: Options<LiteralString<ContextKey>>,

diff --git a/src/types.ts b/src/types.ts
@@ -2,6 +2,9 @@ import type { Context } from "hono";
 import { pino } from "pino";
 import type { PinoLogger } from "./logger";
 
+/**
+ * pinoLogger options
+ */
 export interface Options<ContextKey extends string = "logger"> {
   /**
    * custom context key
@@ -57,13 +60,13 @@ export interface Options<ContextKey extends string = "logger"> {
    *
    * @description set to false to disable
    */
-  http?: false | HttpOptions;
+  http?: false | HttpLoggerOptions;
 }
 
 /**
  * http request log options
  */
-export type HttpOptions = {
+export type HttpLoggerOptions = {
   /**
    * custom request id
    * @deprecated Changed to use referRequestIdKey. will be removed in 1.0.0
@@ -239,7 +242,7 @@ export type HttpOptions = {
 };
 
 /**
- * hono-pino default env for hono
+ * hono-pino default env for hono context
  *
  * @example
  *