@loggerjs/pretty API

Generated from packages/pretty/dist/**/*.d.ts. Source report: api-reports/loggerjs-pretty.api.md.

console-transport.d.ts

import { type LogEvent, type Transport } from "@loggerjs/core";
import { type PrettyFormatterOptions } from "./formatter.js";
export interface PrettyConsoleLike {
    debug?: (...args: unknown[]) => void;
    error?: (...args: unknown[]) => void;
    info?: (...args: unknown[]) => void;
    log?: (...args: unknown[]) => void;
    trace?: (...args: unknown[]) => void;
    warn?: (...args: unknown[]) => void;
}
export interface PrettyConsoleTransportOptions extends PrettyFormatterOptions {
    name?: string;
    browserStyles?: boolean | "auto";
    includeEvent?: boolean;
    console?: PrettyConsoleLike;
    filter?: (event: LogEvent) => boolean;
}
export declare function prettyConsoleTransport(options?: PrettyConsoleTransportOptions): Transport;

formatter.d.ts

import { type EnabledLogLevelName, type LogEvent } from "@loggerjs/core";
export type PrettyColorMode = "auto" | "always" | "never";
export type PrettyRenderMode = "compact" | "expanded";
export type PrettyTimeFormat = "iso" | "local" | "time" | "none" | ((event: LogEvent) => string);
export interface PrettyLevelStyle {
    label: string;
    ansi: string;
    css: string;
}
export type PrettyLevelStyles = Partial<Record<EnabledLogLevelName, Partial<PrettyLevelStyle>>>;
export interface PrettyFormatterOptions {
    colors?: PrettyColorMode;
    mode?: PrettyRenderMode;
    time?: PrettyTimeFormat;
    includeLogger?: boolean;
    includeType?: boolean;
    includeTags?: boolean;
    includeData?: boolean;
    includeError?: boolean;
    includeContext?: boolean;
    includeTrace?: boolean;
    includeSource?: boolean;
    includeId?: boolean;
    maxInlineLength?: number;
    maxObjectDepth?: number;
    maxObjectKeys?: number;
    levelStyles?: PrettyLevelStyles;
}
export interface PrettyDetail {
    key: string;
    value: unknown;
    text: string;
}
export interface PrettyFormattedEvent {
    text: string;
    ansiText: string;
    browserArgs: unknown[];
    details: PrettyDetail[];
}
export declare function formatPrettyEvent(event: LogEvent, options?: PrettyFormatterOptions): PrettyFormattedEvent;

index.d.ts

export * from "./formatter.js";
export * from "./console-transport.js";
export * from "./stream-transport.js";

stream-transport.d.ts

import { type LoggerLevel, type Transport } from "@loggerjs/core";
import { type PrettyFormatterOptions } from "./formatter.js";
export interface PrettyWritableLike {
    isTTY?: boolean;
    write: (chunk: string) => unknown;
    on?: (event: "error", listener: (error: Error) => void) => unknown;
    off?: (event: "error", listener: (error: Error) => void) => unknown;
    once?: (event: "drain", listener: () => void) => unknown;
    end?: (callback?: (error?: Error | null) => void) => unknown;
}
export interface PrettyProcessLike {
    stdout?: PrettyWritableLike;
    stderr?: PrettyWritableLike;
    env?: Record<string, string | undefined>;
}
export interface PrettyStreamTransportOptions extends PrettyFormatterOptions {
    name?: string;
    stream?: PrettyWritableLike;
    process?: PrettyProcessLike;
    minLevel?: LoggerLevel;
    newline?: string;
    endOnClose?: boolean;
}
export type PrettyStdoutTransportOptions = Omit<PrettyStreamTransportOptions, "stream"> & {
    stream?: PrettyWritableLike;
};
export declare function prettyStreamTransport(options?: PrettyStreamTransportOptions): Transport;
export declare function prettyStdoutTransport(options?: PrettyStdoutTransportOptions): Transport;
export declare function prettyStderrTransport(options?: PrettyStdoutTransportOptions): Transport;