@logtape/adaptor-pino/dist/mod.d.ts

Pino adapter for LogTape logging library

import { Sink } from "@logtape/logtape";
import { Logger } from "pino";

//#region mod.d.ts

/**
 * Options for configuring the Pino sink adapter.
 * @since 1.0.0
 */
interface PinoSinkOptions {
  /**
   * Configuration for how LogTape categories are handled in Pino logs.
   * - `false` or `undefined`: Categories are not included in the log message
   * - `true`: Categories are included with default formatting
   * - `CategoryOptions`: Custom category formatting configuration
   */
  readonly category?: boolean | CategoryOptions;
}
/**
 * Configuration options for formatting LogTape categories in Pino log messages.
 * @since 1.0.0
 */
interface CategoryOptions {
  /**
   * The separator used to join category parts when multiple categories exist.
   * @default "·"
   */
  readonly separator?: string;
  /**
   * Where to position the category in the log message.
   * - `"start"`: Category appears at the beginning of the message
   * - `"end"`: Category appears at the end of the message
   * @default "start"
   */
  readonly position?: "start" | "end";
  /**
   * The decorator used to format the category in the log message.
   * - `"[]"`: [category] format
   * - `"()"`: (category) format
   * - `"<>"`: <category> format
   * - `"{}"`: {category} format
   * - `":"`: category: format
   * - `"-"`: category - format
   * - `"|"`: category | format
   * - `"/"`: category / format
   * - `""`: category format (no decoration)
   * @default ":"
   */
  readonly decorator?: "[]" | "()" | "<>" | "{}" | ":" | "-" | "|" | "/" | "";
}
/**
 * Creates a LogTape sink that forwards log records to a Pino logger.
 *
 * This adapter allows LogTape-enabled libraries to integrate seamlessly with
 * applications that use Pino for logging.
 *
 * @example
 * ```typescript
 * import { configure } from "@logtape/logtape";
 * import { getPinoSink } from "@logtape/adaptor-pino";
 * import pino from "pino";
 *
 * const pinoLogger = pino();
 *
 * await configure({
 *   sinks: {
 *     pino: getPinoSink(pinoLogger, {
 *       category: {
 *         position: "start",
 *         decorator: "[]",
 *         separator: "."
 *       }
 *     })
 *   },
 *   loggers: [
 *     { category: "my-library", sinks: ["pino"] }
 *   ]
 * });
 * ```
 *
 * @typeParam CustomLevels The custom log levels supported by the Pino logger.
 * @typeParam UseOnlyCustomLevels Whether to use only custom levels defined
 *                                in the Pino logger.
 * @param logger The Pino logger instance to forward logs to.
 * @param options Configuration options for the sink adapter.
 * @returns A LogTape sink function that can be used in LogTape configuration.
 * @since 1.0.0
 */
declare function getPinoSink<CustomLevels extends string, UseOnlyCustomLevels extends boolean>(logger: Logger<CustomLevels, UseOnlyCustomLevels>, options?: PinoSinkOptions): Sink;
/**
 * Automatically configures LogTape to route all logs to a Pino logger.
 *
 * This is a convenience function that automatically sets up LogTape to forward
 * all log records to a Pino logger instance.
 *
 * @example Basic auto-configuration
 * ```typescript
 * import pino from "pino";
 * import { install } from "@logtape/adaptor-pino";
 *
 * const pinoLogger = pino();
 *
 * // Automatically route all LogTape logs to the Pino logger
 * install(pinoLogger);
 *
 * // Now any LogTape-enabled library will log through Pino
 * import { getLogger } from "@logtape/logtape";
 * const logger = getLogger("my-app");
 * logger.info("This will be logged through Pino");
 * ```
 *
 * @example Auto-configuration with custom options
 * ```typescript
 * import pino from "pino";
 * import { install } from "@logtape/adaptor-pino";
 *
 * const pinoLogger = pino({
 *   level: "info",
 *   transport: {
 *     target: "pino-pretty"
 *   }
 * });
 *
 * install(pinoLogger, {
 *   category: {
 *     position: "start",
 *     decorator: "[]",
 *     separator: "."
 *   }
 * });
 * ```
 *
 * @typeParam CustomLevels The custom log levels supported by the Pino logger.
 * @typeParam UseOnlyCustomLevels Whether to use only custom levels defined
 *                                in the Pino logger.
 * @param logger The Pino logger instance to forward logs to.
 * @param options Configuration options for the sink adapter.
 * @since 1.0.0
 */
declare function install<CustomLevels extends string, UseOnlyCustomLevels extends boolean>(logger: Logger<CustomLevels, UseOnlyCustomLevels>, options?: PinoSinkOptions): void;
//# sourceMappingURL=mod.d.ts.map
//#endregion
export { CategoryOptions, PinoSinkOptions, getPinoSink, install };
//# sourceMappingURL=mod.d.ts.map