@types/bunyan

What is @types/bunyan?

@types/bunyan provides TypeScript type definitions for the Bunyan logging library, which is a simple and fast JSON logging library for Node.js services.

What are @types/bunyan's main functionalities?

Basic Logging

This feature allows you to create a basic logger and log messages at the 'info' level.

const bunyan = require('bunyan');
const log = bunyan.createLogger({name: 'myapp'});
log.info('Hello, world!');

Logging with Different Levels

This feature allows you to log messages at different levels such as trace, debug, info, warn, error, and fatal.

const bunyan = require('bunyan');
const log = bunyan.createLogger({name: 'myapp'});
log.trace('Trace message');
log.debug('Debug message');
log.info('Info message');
log.warn('Warn message');
log.error('Error message');
log.fatal('Fatal message');

Child Loggers

This feature allows you to create child loggers that inherit properties from the parent logger but can also have additional context-specific properties.

const bunyan = require('bunyan');
const log = bunyan.createLogger({name: 'myapp'});
const child = log.child({widget_type: 'foo'});
child.info('Hello from child logger');

Serializers

This feature allows you to use serializers to format log messages, such as including request and response objects in a structured way.

const bunyan = require('bunyan');
const log = bunyan.createLogger({name: 'myapp', serializers: bunyan.stdSerializers});
log.info({req: {method: 'GET', url: '/'}}, 'Request received');

Other packages similar to @types/bunyan

winston

Winston is another popular logging library for Node.js that supports multiple transports (e.g., console, file, HTTP) and log levels. It is more flexible in terms of output formats and transport options compared to Bunyan.

pino

Pino is a very fast JSON logger for Node.js, similar to Bunyan. It focuses on performance and low overhead, making it suitable for high-throughput applications. Pino also provides a CLI tool for pretty-printing logs.

log4js

Log4js is a logging library inspired by the Java log4j library. It provides a variety of appenders for different output targets and supports hierarchical loggers. It is more feature-rich but can be more complex to configure compared to Bunyan.

README

Installation

npm install --save @types/bunyan

Summary

This package contains type definitions for bunyan (https://github.com/trentm/node-bunyan).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/bunyan.

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: @types/node

Credits

These definitions were written by Alex Mikhalev.