Interface Options

Options for configuring the access log middleware.

interface Options {
    customErrorMessage?: (
        req: IncomingMessage,
        res: ServerResponse,
        error: Error,
    ) => string;
    customErrorObject?: (
        req: IncomingMessage,
        res: ServerResponse,
        error: Error,
        val: any,
    ) => any;
    customLogLevel?: (
        req: IncomingMessage,
        res: ServerResponse,
        error?: Error,
    ) => LevelWithSilent;
    customSuccessMessage?: (
        req: IncomingMessage,
        res: ServerResponse,
        responseTime: number,
    ) => string;
    customSuccessObject?: (
        req: IncomingMessage,
        res: ServerResponse,
        val: any,
    ) => any;
    ignore?: (req: IncomingMessage) => boolean;
    ignorePaths?: (string | RegExp)[];
    logger: Logger;
}

Properties

customErrorMessage? customErrorObject? customLogLevel? customSuccessMessage? customSuccessObject? ignore? ignorePaths? logger

Properties

OptionalcustomErrorMessage

customErrorMessage?: (
    req: IncomingMessage,
    res: ServerResponse,
    error: Error,
) => string

Custom function to generate error messages.

OptionalcustomErrorObject

customErrorObject?: (
    req: IncomingMessage,
    res: ServerResponse,
    error: Error,
    val: any,
) => any

Custom function to modify the error log object.

OptionalcustomLogLevel

customLogLevel?: (
    req: IncomingMessage,
    res: ServerResponse,
    error?: Error,
) => LevelWithSilent

Custom function to determine log level based on request, response and error.

OptionalcustomSuccessMessage

customSuccessMessage?: (
    req: IncomingMessage,
    res: ServerResponse,
    responseTime: number,
) => string

Custom function to generate success messages.

OptionalcustomSuccessObject

customSuccessObject?: (
    req: IncomingMessage,
    res: ServerResponse,
    val: any,
) => any

Custom function to modify the success log object.

Optionalignore

ignore?: (req: IncomingMessage) => boolean

Custom ignore options for automatic logging.

OptionalignorePaths

ignorePaths?: (string | RegExp)[]

Array of paths or regular expressions to ignore from logging.

logger

logger: Logger

A Logger instance used for logging requests and responses.

Settings

Member Visibility

On This Page

Properties