Documentation
    Preparing search index...

    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;
    }
    Index

    Properties

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

    Properties

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

    Custom function to generate error messages.

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

    Custom function to modify the error log object.

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

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

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

    Custom function to generate success messages.

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

    Custom function to modify the success log object.

    ignore?: (req: IncomingMessage) => boolean

    Custom ignore options for automatic logging.

    ignorePaths?: (string | RegExp)[]

    Array of paths or regular expressions to ignore from logging.

    logger: Logger

    A Logger instance used for logging requests and responses.

    Settings

    Member Visibility

    On This Page

    Properties