Documentation
    Preparing search index...

    Type Alias PrettyTargetOptions

    Options accepted by the pino-pretty module. Copy-pasted from https://github.com/pinojs/pino-pretty/blob/master/index.d.ts

    type PrettyTargetOptions = {
        hideObject?: boolean;
        translateTime?: boolean | string;
        levelFirst?: boolean;
        levelKey?: string;
        levelLabel?: string;
        messageKey?: string;
        singleLine?: boolean;
        timestampKey?: string;
        minimumLevel?: Level;
        messageFormat?:
            | false
            | string
            | (
                (
                    log: Record<string, unknown>,
                    messageKey: string,
                    levelLabel: string,
                ) => string
            );
        colorize?: boolean;
        crlf?: boolean;
        errorLikeObjectKeys?: string[];
        errorProps?: string;
        ignore?: string;
        include?: string;
        sync?: boolean;
        destination?: string | number | DestinationStream | NodeJS.WritableStream;
        append?: boolean;
        mkdir?: boolean;
        customPrettifiers?: Record<string, (inputData: string | object) => string>;
        customLevels?: string | object;
        customColors?: string | object;
        useOnlyCustomProps?: boolean;
    }
    Index

    Properties

    hideObject? translateTime? levelFirst? levelKey? levelLabel? messageKey? singleLine? timestampKey? minimumLevel? messageFormat? colorize? crlf? errorLikeObjectKeys? errorProps? ignore? include? sync? destination? append? mkdir? customPrettifiers? customLevels? customColors? useOnlyCustomProps?

    Properties

    hideObject?: boolean

    Whether to hide objects in the output

    translateTime?: boolean | string

    Whether to translate time format or custom time format string

    levelFirst?: boolean

    Whether to show the log level first

    levelKey?: string

    Key name for the log level

    levelLabel?: string

    Label to use for the log level

    messageKey?: string

    Key name for the log message

    singleLine?: boolean

    Whether to format output as a single line

    timestampKey?: string

    Key name for the timestamp

    minimumLevel?: Level

    Minimum log level to display

    messageFormat?:
        | false
        | string
        | (
            (
                log: Record<string, unknown>,
                messageKey: string,
                levelLabel: string,
            ) => string
        )

    Message formatting configuration

    colorize?: boolean

    Whether to colorize the output

    crlf?: boolean

    Whether to use CRLF line endings

    errorLikeObjectKeys?: string[]

    Keys that should be treated as error-like objects

    errorProps?: string

    Error properties to include in output

    ignore?: string

    Keys to ignore in the output

    include?: string

    Keys to include in the output

    sync?: boolean

    Whether to use synchronous writing

    destination?: string | number | DestinationStream | NodeJS.WritableStream

    Destination for the pretty output

    append?: boolean

    Whether to append to existing file

    mkdir?: boolean

    Whether to create directories if they don't exist

    customPrettifiers?: Record<string, (inputData: string | object) => string>

    Custom prettifiers for specific keys

    customLevels?: string | object

    Custom log levels configuration

    customColors?: string | object

    Custom colors configuration

    useOnlyCustomProps?: boolean

    Whether to use only custom properties

    Settings

    Member Visibility

    On This Page

    Properties