@purinton/log

@purinton/log

A minimal, flexible logging library for Node.js, built on top of winston. Supports both ESM and CommonJS, with TypeScript types included.

Table of Contents

• Features
• Installation
• Usage
  • ESM Example
  • CommonJS Example
• API
• TypeScript
• Support
• License
• Links

Features

• Simple, consistent logging API for Node.js
• Built on winston
• Supports both ESM and CommonJS
• Default and named exports for maximum flexibility
• TypeScript type definitions included
• Supports logging primitives and arrays as meta:
  • log.info('msg', 42) logs { value: 42 }
  • log.info('msg', [1,2,3]) logs { value: [1,2,3] }

Installation

npm install @purinton/log

Usage

ESM Example

// Example usage for ESM
import log, { log as namedLog, createLogger } from '@purinton/log';

log.info('Hello from example.mjs (default import)', { foo: 'bar' });
log.info('Primitive value', 42); // primitive value
log.info('Array value', [1,2,3]); // array value

namedLog.info('Hello from example.mjs (named import)', { foo: 'bar' });
namedLog.info('Primitive value', 'test'); // primitive value

const customLogger = createLogger({ level: 'debug' });
customLogger.debug('Custom logger debug message', { custom: true });
customLogger.debug('Primitive debug', true); // primitive value

CommonJS Example

// Example usage for CommonJS
const log = require('@purinton/log');
log.info('Hello from example.cjs (default require)', { foo: 'bar' });
log.info('Primitive value', 42); // primitive value
log.info('Array value', [1,2,3]); // array value

const namedLog = require('@purinton/log');
namedLog.info('Hello from example.cjs (named require)', { foo: 'bar' });
namedLog.info('Primitive value', 'test'); // primitive value

const { createLogger } = require('@purinton/log');
const customLogger = createLogger({ level: 'debug' });
customLogger.debug('Custom logger debug message', { custom: true });
customLogger.debug('Primitive debug', true); // primitive value

API

log (default and named export)

A pre-configured logger instance. Available as both the default and a named export (log).

• .info(message, meta?)
• .debug(message, meta?)
• .warn(message, meta?)
• .error(message, meta?)
• ...and all other winston logger methods.

Meta argument:

• If you pass a primitive or array as the second argument, it will be logged as { value: ... }.
• If you pass an object, it will be logged as usual.

createLogger(options)

Creates a new winston logger instance.

Options:

• level (string): Log level (default: process.env.LOG_LEVEL or 'info')
• transports (array): Array of winston transports (default: Console)

Returns: winston.Logger

TypeScript

Type definitions are included:

export declare function createLogger(options?: { level?: string; transports?: any[]; }): import('winston').Logger & {
  debug(message: string, meta?: any): void;
  info(message: string, meta?: any): void;
  warn(message: string, meta?: any): void;
  error(message: string, meta?: any): void;
};
export declare const log: import('winston').Logger & {
  debug(message: string, meta?: any): void;
  info(message: string, meta?: any): void;
  warn(message: string, meta?: any): void;
  error(message: string, meta?: any): void;
};
export default log;

Support

For help, questions, or to chat with the author and community, visit:

Purinton Dev on Discord

License

MIT © 2025 Russell Purinton

Links

• GitHub
• npm
• Discord
• Winston Logger