Class TypeOrmLogger

Hierarchy

AbstractLogger
- TypeOrmLogger

Index

Constructors

Properties

Methods

isLogEnabledFor log logMigration logQuery logQueryError logQuerySlow logSchemaBuild prepareLogMessages stringifyParams writeLog

Constructors

constructor

new TypeOrmLogger(opts: TypeOrmLoggerOptions): TypeOrmLogger
Parameters
- opts: TypeOrmLoggerOptions
Returns TypeOrmLogger
Overrides AbstractLogger.constructor
- Defined in libs/core/src/logger/classes/typeorm-logger.ts:16

Properties

logger

logger: WinstonLogger

`Protected` `Optional`options

options?: LoggerOptions

Methods

`Protected`isLogEnabledFor

isLogEnabledFor(
    type?:
        | "schema"
        | "query"
        | "error"
        | "warn"
        | "info"
        | "log"
        | "migration"
        | "query-error"
        | "query-slow"
        | "schema-build",
): boolean
Check is logging for level or message type is enabled.
Parameters
- Optionaltype:
      | "schema"
      | "query"
      | "error"
      | "warn"
      | "info"
      | "log"
      | "migration"
      | "query-error"
      | "query-slow"
      | "schema-build"
Returns boolean
Inherited from AbstractLogger.isLogEnabledFor
- Defined in node_modules/typeorm/logger/AbstractLogger.d.ts:35

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
Inherited from AbstractLogger.log
- Defined in node_modules/typeorm/logger/AbstractLogger.d.ts:31

logMigration

logMigration(message: string, queryRunner?: QueryRunner): void
Logs events from the migration run process.
Parameters
- message: string
- OptionalqueryRunner: QueryRunner
Returns void
Inherited from AbstractLogger.logMigration
- Defined in node_modules/typeorm/logger/AbstractLogger.d.ts:26

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
Inherited from AbstractLogger.logQuery
- Defined in node_modules/typeorm/logger/AbstractLogger.d.ts:10

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
Inherited from AbstractLogger.logQueryError
- Defined in node_modules/typeorm/logger/AbstractLogger.d.ts:14

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
Inherited from AbstractLogger.logQuerySlow
- Defined in node_modules/typeorm/logger/AbstractLogger.d.ts:18

logSchemaBuild

logSchemaBuild(message: string, queryRunner?: QueryRunner): void
Logs events from the schema build process.
Parameters
- message: string
- OptionalqueryRunner: QueryRunner
Returns void
Inherited from AbstractLogger.logSchemaBuild
- Defined in node_modules/typeorm/logger/AbstractLogger.d.ts:22

`Protected`prepareLogMessages

prepareLogMessages(
    logMessage:
        | string
        | number
        | LogMessage
        | (string | number | LogMessage)[],
    options?: Partial<PrepareLogMessagesOptions>,
    queryRunner?: QueryRunner,
): LogMessage[]
Prepare and format log messages
Parameters
- logMessage: string | number | LogMessage | (string | number | LogMessage)[]
- Optionaloptions: Partial<PrepareLogMessagesOptions>
- OptionalqueryRunner: QueryRunner
Returns LogMessage[]
Inherited from AbstractLogger.prepareLogMessages
- Defined in node_modules/typeorm/logger/AbstractLogger.d.ts:43

`Protected`stringifyParams

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[]
Inherited from AbstractLogger.stringifyParams
- Defined in node_modules/typeorm/logger/AbstractLogger.d.ts:48

`Protected`writeLog

writeLog(level: LogLevel, logMessage: LogMessage | LogMessage[]): void
Write log to specific output.
Parameters
- level: LogLevel
- logMessage: LogMessage | LogMessage[]
Returns void
Overrides AbstractLogger.writeLog
- Defined in libs/core/src/logger/classes/typeorm-logger.ts:25

Class TypeOrmLogger

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TypeOrmLogger

Properties

logger

Protected Optionaloptions

Methods

ProtectedisLogEnabledFor

Parameters

Returns boolean

log

Parameters

Returns void

logMigration

Parameters

Returns void

logQuery

Parameters

Returns void

logQueryError

Parameters

Returns void

logQuerySlow

Parameters

Returns void

logSchemaBuild

Parameters

Returns void

ProtectedprepareLogMessages

Parameters

Returns LogMessage[]

ProtectedstringifyParams

Parameters

Returns string | any[]

ProtectedwriteLog

Parameters

Returns void

Settings

On This Page

`Protected` `Optional`options

`Protected`isLogEnabledFor

`Protected`prepareLogMessages

`Protected`stringifyParams

`Protected`writeLog