From f33ca24b536cf814a342fc167034ac4e60f23624 Mon Sep 17 00:00:00 2001 From: Jonathan Bernard Date: Mon, 14 Jul 2025 15:37:41 -0500 Subject: [PATCH] timestamp -> ts; error -> err --- package.json | 2 +- src/console-log-appender.ts | 10 +++++----- src/log-message.ts | 12 ++++++------ src/logger.ts | 10 +++++----- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/package.json b/package.json index 6ae448b..f3a1ace 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@jdbernard/logging", - "version": "2.1.0", + "version": "2.2.0", "description": "Simple Javascript logging service.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/console-log-appender.ts b/src/console-log-appender.ts index 8215f7e..0f17f86 100644 --- a/src/console-log-appender.ts +++ b/src/console-log-appender.ts @@ -60,19 +60,19 @@ export class ConsoleLogAppender implements LogAppender { const fmtMsg = this.formatter(msg); if (typeof fmtMsg === "string") { - if (msg.error || msg.stacktrace) { - logMethod(fmtMsg, msg.error ?? msg.stacktrace); + if (msg.err || msg.stacktrace) { + logMethod(fmtMsg, msg.err ?? msg.stacktrace); } else { logMethod(fmtMsg); } } else { - const { message, _error, _stacktrace, ...rest } = fmtMsg; + const { message, _err, _stacktrace, ...rest } = fmtMsg; const summary = `${LogLevel[msg.level]} -- ${msg.scope}: ${ message ?? fmtMsg.method }\n`; - if (msg.error || msg.stacktrace) { - logMethod(summary, msg.error ?? msg.stacktrace, rest); + if (msg.err || msg.stacktrace) { + logMethod(summary, msg.err ?? msg.stacktrace, rest); } else { logMethod(summary, rest); } diff --git a/src/log-message.ts b/src/log-message.ts index c33bdb7..b296e1c 100644 --- a/src/log-message.ts +++ b/src/log-message.ts @@ -27,8 +27,8 @@ export interface LogMessage { level: LogLevel; msg: string | Record; stacktrace?: string; - error?: Error; - timestamp: Date; + err?: Error; + ts: Date; } export type FlattenedLogMessage = Record; @@ -45,12 +45,12 @@ export type FlattenedLogMessage = Record; * * ```typescript * const logger = logService.getLogger('example'); - * logger.info({ foo: 'bar', baz: 'qux', timestamp: 'today', level: LogLevel.WARN }); + * logger.info({ foo: 'bar', baz: 'qux', ts: 'today', level: LogLevel.WARN }); * ``` * * Should result after flattening in a structured log message like: * ```json - * {"scope":"example","level":"INFO","foo":"bar","baz":"qux","timestamp":"2020-01-01T00:00:00.000Z"} + * {"scope":"example","level":"INFO","foo":"bar","baz":"qux","ts":"2020-01-01T00:00:00.000Z"} * ``` */ export function flattenMessage(logMsg: LogMessage): FlattenedLogMessage { @@ -63,8 +63,8 @@ export function flattenMessage(logMsg: LogMessage): FlattenedLogMessage { "scope", "level", "stacktrace", - "error", - "timestamp", + "err", + "ts", ]), ...rest, level: LogLevel[logMsg.level], diff --git a/src/logger.ts b/src/logger.ts index a47b5de..f1b7366 100644 --- a/src/logger.ts +++ b/src/logger.ts @@ -67,17 +67,17 @@ export class Logger { level, msg: '', stacktrace: '', - timestamp: new Date(), + ts: new Date(), }; if (msg === undefined || msg === null) { logMsg.msg = msg; logMsg.stacktrace = stacktrace ?? ''; } else if (msg instanceof Error) { - const error = msg as Error; - logMsg.error = error; - logMsg.msg = `${error.name}: ${error.message}`; - logMsg.stacktrace = stacktrace ?? error.stack ?? ''; + const err = msg as Error; + logMsg.err = err; + logMsg.msg = `${err.name}: ${err.message}`; + logMsg.stacktrace = stacktrace ?? err.stack ?? ''; } else if (isDeferredMsg(msg)) { logMsg.msg = msg(); logMsg.stacktrace = stacktrace == null ? '' : stacktrace;