@types/pino-std-serializers

What is @types/pino-std-serializers?

@types/pino-std-serializers provides TypeScript type definitions for the pino-std-serializers package, which is used to serialize standard Node.js objects such as HTTP requests, responses, and errors for logging purposes.

What are @types/pino-std-serializers's main functionalities?

HTTP Request Serializer

This feature allows you to serialize HTTP request objects for logging. The `asReqValue` function converts the request object into a format suitable for logging.

const pino = require('pino');
const { asReqValue } = require('pino-std-serializers');

const logger = pino({
  serializers: {
    req: asReqValue
  }
});

const req = { method: 'GET', url: '/test', headers: { host: 'localhost' } };
logger.info({ req }, 'Request received');

HTTP Response Serializer

This feature allows you to serialize HTTP response objects for logging. The `asResValue` function converts the response object into a format suitable for logging.

const pino = require('pino');
const { asResValue } = require('pino-std-serializers');

const logger = pino({
  serializers: {
    res: asResValue
  }
});

const res = { statusCode: 200, headers: { 'content-type': 'application/json' } };
logger.info({ res }, 'Response sent');

Error Serializer

This feature allows you to serialize error objects for logging. The `asErrValue` function converts the error object into a format suitable for logging.

const pino = require('pino');
const { asErrValue } = require('pino-std-serializers');

const logger = pino({
  serializers: {
    err: asErrValue
  }
});

const error = new Error('Something went wrong');
logger.error({ err: error }, 'Error occurred');

Other packages similar to @types/pino-std-serializers

@types/bunyan

@types/bunyan provides TypeScript type definitions for the Bunyan logging library. Bunyan is another popular logging library for Node.js that offers similar functionalities, including serializers for HTTP requests, responses, and errors.

@types/winston

@types/winston provides TypeScript type definitions for the Winston logging library. Winston is a versatile logging library for Node.js that also supports custom serializers for various objects, including HTTP requests and responses.

@types/log4js

@types/log4js provides TypeScript type definitions for the Log4js logging library. Log4js is another logging library for Node.js that offers customizable logging and serialization capabilities similar to pino-std-serializers.

README

This is a stub types definition for @types/pino-std-serializers (https://github.com/pinojs/pino-std-serializers#readme).

pino-std-serializers provides its own type definitions, so you don't need @types/pino-std-serializers installed!