voxpelliPino / Bunyan Adaptor
Types and mapper for Pino / Bunyan logging methods.
Support Pino / Bunyan compatible loggers with fallback console.log().
BunyanLite – simplified Pino / Bunyan type subsets
Apart from the actual adapter, this module also ships with some useful generic TypeScript types, where BunyanLite is the most usable of them.
The BunyanLite type can be used wherever one wants to reference a basic Pino / Bunyan subset. That type can then be fulfilled by Pino, Bunyan, a logger created by this module or by another module implementing the same subset.
All Pino / Bunyan type subsets
BunyanLite– specifies the lite subset of the Bunyan interface that this module supportsBunyanLogMethod– specifies the very simple syntax for the individual log methodsBunyanChildMethod– specified the syntax of thechild()method
Pino / Bunyan subset that's part of BunyanLite
.fatal().error().warn().info().debug().trace().child(data)
createLogger() – map any logger to BunyanLite subset
Simple CommonJS example:
const logger = require('bunyan-adaptor')({
log: console.log.bind(console),
error: console.error.bind(console),
});
logger.error('Warning'); // Uses console.error()
logger.info('Informational'); // Uses console.log()
Simple ESM example:
import createLogger from 'bunyan-adaptor';
const logger = createLogger({
log: console.log.bind(console),
error: console.error.bind(console),
});
logger.error('Warning'); // Uses console.error()
logger.info('Informational'); // Uses console.log()
Also available as a non-default export:
const { createLogger } = require('bunyan-adaptor');
import { createLogger } from 'bunyan-adaptor';
createLogger(options)
Maps options methods to all seven Bunyan log levels.
.fatal()– maps tooptions.fataland fallbacks tooptions.errorandoptions.login that order.error()– maps tooptions.errorand fallbacks tooptions.login that order.warn()– maps tooptions.warnand fallbacks tooptions.log.info()– maps tooptions.infoand fallbacks tooptions.log.debug()– maps tooptions.debugand fallbacks tooptions.verboseandoptions.login that order.trace()– maps tooptions.traceand fallbacks tooptions.verboseandoptions.login that order
options.log itself fallbacks to console.log()
In addition to the above there's also support for:
.child(data)– used to create a child logger. Defaults to built in method, can be overriden usingoptions.child