@mcbe-mods/log

Level-based logging utility for Minecraft Bedrock Edition Script API.

Install

npm install @mcbe-mods/log

Usage

import { Log } from '@mcbe-mods/log'

// Default level (fallback when not set per-instance)
Log.defaultLevel = 'debug'

// Or set per-instance
const log = new Log('MyAddon', { level: 'debug' })

// debug takes a factory function (lazy evaluation — avoids unnecessary work)
log.debug(() => `Expensive: ${compute()}`)
// info/warn/error/fatal take direct values
log.info('Hello')
log.warn('Something suspicious', detail)
log.error('Something broke', error)
log.fatal('Cannot recover')

// Child logger (inherits parent options, can override)
const child = log.child('Sub', { level: 'warn' })
child.info('scoped message') // skipped if parent set debug but child overrode to warn

// Timestamps
Log.defaultTimestamp = true
// or per-instance
const log2 = new Log('MyAddon', { timestamp: true, dateFormat: 'HH:mm:ss' })

Options

interface LogOptions {
  level?: LogLevel // default: Log.defaultLevel
  timestamp?: boolean // default: Log.defaultTimestamp
  dateFormat?: string // default: Log.defaultDateFormat
}

Methods

| Method | Signature | Description | |--------|-----------|-------------| | debug | (...args: unknown[]): void / (fn: () => unknown): void | Overloaded: direct values or lazy thunk (fn called only when level ≤ debug) | | info | (...args: unknown[]): void | Direct values | | warn | (...args: unknown[]): void | Direct values | | error | (...args: unknown[]): void | Direct values | | fatal | (...args: unknown[]): void | Direct values | | child | (name: string, options?: LogOptions): Log | Creates a child logger scoped to parentName:name. Inherits parent's options unless overridden |

License

MIT