Merge branch 'dev' of https://github.com/wgtechlabs/log-engine into dev

Author: warengonzaga

src/formatter/data-formatter.ts

@@ -4,10 +4,12 @@
  */
 
 /**
- * Formats data objects for log output
- * Converts objects to readable string format with proper handling of edge cases
- * @param data - Data to format (any type)
- * @returns Formatted string representation of the data
+ * Converts input data to a readable string suitable for log output.
+ *
+ * Returns 'null' for `null`, an empty string for `undefined`, the value itself for strings, and string representations for numbers and booleans. For other types, attempts JSON serialization; if serialization fails, returns '[Object]'.
+ *
+ * @param data - The value to format for logging
+ * @returns The formatted string representation of the input data
  */
 export function formatData(data: any): string {
     if (data === null) {
@@ -39,10 +41,11 @@ export function formatData(data: any): string {
 }
 
 /**
- * Apply data styling with colors
- * @param dataString - Formatted data string
- * @param colors - Color scheme for data styling
- * @returns Colored data string
+ * Applies color styling to a formatted data string using the provided color codes.
+ *
+ * @param dataString - The string to be styled; if falsy, an empty string is returned.
+ * @param colors - An object containing `data` (the color code prefix) and `reset` (the color code suffix).
+ * @returns The styled data string with color codes applied, or an empty string if `dataString` is falsy.
  */
 export function styleData(dataString: string, colors: { data: string; reset: string }): string {
     if (!dataString) {

src/formatter/timestamp.ts

@@ -4,9 +4,9 @@
  */
 
 /**
- * Generate formatted timestamp components for log messages
- * Creates both ISO timestamp and localized time string
- * @returns Object containing formatted timestamp components
+ * Generates the current timestamp as both an ISO 8601 string and a compact US English local time string.
+ *
+ * @returns An object containing `isoTimestamp` (ISO 8601 format) and `timeString` (localized time string without spaces)
  */
 export function getTimestampComponents(): {
     isoTimestamp: string;
@@ -27,11 +27,12 @@ export function getTimestampComponents(): {
 }
 
 /**
- * Format timestamp components with colors for console output
- * @param isoTimestamp - ISO formatted timestamp
- * @param timeString - Local time string
- * @param colors - Color scheme to use
- * @returns Formatted and colored timestamp string
+ * Returns a formatted string combining an ISO timestamp and a local time string, each wrapped with specified color codes for console output.
+ *
+ * @param isoTimestamp - The ISO 8601 formatted timestamp to display
+ * @param timeString - The local time string to display
+ * @param colors - An object containing color codes for the timestamp, time string, and reset sequence
+ * @returns The combined, colorized timestamp string suitable for log messages
  */
 export function formatTimestamp(
     isoTimestamp: string,