Class TypeOrmLogger

Hierarchy

  • AbstractLogger
    • TypeOrmLogger

Constructors

constructor

Properties

logger options?

Methods

isLogEnabledFor log logMigration logQuery logQueryError logQuerySlow logSchemaBuild prepareLogMessages stringifyParams writeLog

Constructors

constructor

Properties

logger

logger: WinstonLogger

Protected Optionaloptions

options?: LoggerOptions

Methods

ProtectedisLogEnabledFor

  • isLogEnabledFor(
        type?:
            | "error"
            | "warn"
            | "info"
            | "log"
            | "query"
            | "schema"
            | "migration"
            | "query-error"
            | "query-slow"
            | "schema-build",
    ): boolean

    Check is logging for level or message type is enabled.

    Parameters

    • Optionaltype:
          | "error"
          | "warn"
          | "info"
          | "log"
          | "query"
          | "schema"
          | "migration"
          | "query-error"
          | "query-slow"
          | "schema-build"

    Returns boolean

log

  • log(
        level: "warn" | "info" | "log",
        message: any,
        queryRunner?: QueryRunner,
    ): void

    Perform logging using given logger, or by default to the console. Log has its own level and message.

    Parameters

    • level: "warn" | "info" | "log"
    • message: any
    • OptionalqueryRunner: QueryRunner

    Returns void

logMigration

  • logMigration(message: string, queryRunner?: QueryRunner): void

    Logs events from the migration run process.

    Parameters

    • message: string
    • OptionalqueryRunner: QueryRunner

    Returns void

logQuery

  • logQuery(query: string, parameters?: any[], queryRunner?: QueryRunner): void

    Logs query and parameters used in it.

    Parameters

    • query: string
    • Optionalparameters: any[]
    • OptionalqueryRunner: QueryRunner

    Returns void

logQueryError

  • logQueryError(
        error: string,
        query: string,
        parameters?: any[],
        queryRunner?: QueryRunner,
    ): void

    Logs query that is failed.

    Parameters

    • error: string
    • query: string
    • Optionalparameters: any[]
    • OptionalqueryRunner: QueryRunner

    Returns void

logQuerySlow

  • logQuerySlow(
        time: number,
        query: string,
        parameters?: any[],
        queryRunner?: QueryRunner,
    ): void

    Logs query that is slow.

    Parameters

    • time: number
    • query: string
    • Optionalparameters: any[]
    • OptionalqueryRunner: QueryRunner

    Returns void

logSchemaBuild

  • logSchemaBuild(message: string, queryRunner?: QueryRunner): void

    Logs events from the schema build process.

    Parameters

    • message: string
    • OptionalqueryRunner: QueryRunner

    Returns void

ProtectedprepareLogMessages

  • prepareLogMessages(
        logMessage:
            | string
            | number
            | LogMessage
            | (string | number | LogMessage)[],
        options?: Partial<PrepareLogMessagesOptions>,
    ): LogMessage[]

    Prepare and format log messages

    Parameters

    • logMessage: string | number | LogMessage | (string | number | LogMessage)[]
    • Optionaloptions: Partial<PrepareLogMessagesOptions>

    Returns LogMessage[]

ProtectedstringifyParams

  • stringifyParams(parameters: any[]): string | any[]

    Converts parameters to a string. Sometimes parameters can have circular objects and therefor we are handle this case too.

    Parameters

    • parameters: any[]

    Returns string | any[]

ProtectedwriteLog

  • writeLog(level: LogLevel, logMessage: LogMessage | LogMessage[]): void

    Write log to specific output.

    Parameters

    • level: LogLevel
    • logMessage: LogMessage | LogMessage[]

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods