From 25dfdb470b5225d1a9fa1cc314c6bb78081de0c6 Mon Sep 17 00:00:00 2001 From: Jonathan Bernard Date: Mon, 19 May 2025 17:59:29 -0500 Subject: [PATCH] Change the naming convention for LogMessage internal message field. --- package.json | 2 +- src/log-message.ts | 26 ++++++++++++++------------ 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/package.json b/package.json index 5a7038e..3fdac5c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@jdbernard/logging", - "version": "2.0.0", + "version": "2.1.0", "description": "Simple Javascript logging service.", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/src/log-message.ts b/src/log-message.ts index 0d6191d..2ebeb0d 100644 --- a/src/log-message.ts +++ b/src/log-message.ts @@ -1,4 +1,4 @@ -import { omit } from './util' +import { omit } from "./util"; export enum LogLevel { ALL = 0, @@ -25,7 +25,7 @@ export function parseLogLevel( export interface LogMessage { scope: string; level: LogLevel; - message: string | Record; + msg: string | Record; stacktrace?: string; error?: Error; timestamp: Date; @@ -54,31 +54,33 @@ export type FlattenedLogMessage = Record; * ``` */ export function flattenMessage(msg: LogMessage): FlattenedLogMessage { - if (typeof msg.message === 'string') { + if (typeof msg.msg === "string") { return { ...msg, level: LogLevel[msg.level] }; } else { - const { message, ...rest } = msg; + const { msg, ...rest } = msg; return { - ...omit(message, [ - 'scope', - 'level', - 'stacktrace', - 'error', - 'timestamp', + ...omit(msg, [ + "scope", + "level", + "stacktrace", + "error", + "timestamp", ]), ...rest, level: LogLevel[msg.level], }; } } -export type LogMessageFormatter = (msg: LogMessage) => string | FlattenedLogMessage; +export type LogMessageFormatter = ( + msg: LogMessage, +) => string | FlattenedLogMessage; export function structuredLogMessageFormatter(msg: LogMessage): string { return JSON.stringify(flattenMessage(msg)); } export function simpleTextLogMessageFormatter(msg: LogMessage): string { - return `[${msg.scope}] - ${msg.level}: ${msg.message}`; + return `[${msg.scope}] - ${msg.level}: ${msg.msg}`; } export default LogMessage;