时间戳

首页 > 解决方案 > Typescript - Morgan 和 logger.stream 导致 lint 错误

typescript - Typescript - Morgan 和 logger.stream 导致 lint 错误

问题描述

我尝试使用记录器流功能附加Morgan日志。Winston但是，一旦我尝试附加logger.stream使用 morgan 中间件时，它就会失败并显示以下消息：

Argument of type '"combined"' is not assignable to parameter of type 'FormatFn'.

这是我的温斯顿初始化代码：

import * as appRoot from 'app-root-path';
import * as winston from 'winston';
import { Logger } from 'winston';
import * as fs from 'fs';
import * as stream from 'stream';

const dirLogs = `${appRoot}/logs`;

// It's call during initialization, we can block the thread
if (!fs.existsSync(dirLogs)) {
  fs.mkdirSync(dirLogs);
}
// define the custom settings for each transport (file, console)
const options = {
  file: {
    level: 'info',
    filename: `${dirLogs}/app.log`,
    handleExceptions: true,
    json: true,
    maxsize: 5242880, // 5MB
    maxFiles: 5,
    colorize: false,
  },
  console: {
    level: 'debug',
    handleExceptions: true,
    json: false,
    colorize: true,
  },
};

// Keep it simple to focus on the need first
// I think Logger should send logs to a logger service
const logger = new Logger({
  level: 'info',
  transports: [
    new winston.transports.File(options.file),
    new winston.transports.Console(options.console),
  ],
  exitOnError: false, // do not exit on handled exceptions
});

// If I don't use the stream.Duplex, it cause another lint error.
logger.stream = (options?: any) => new stream.Duplex({
  write: function (message: string, encoding: any) {
      logger.info(message.trim());
  }
});

export default logger;

然后，我尝试使用 Morgan 的代码。

// ... All import
import logger from './logger/index';

// ... Then later the code
this.expressApp.use(morgan('combined', { stream: logger.stream }));

我不确定为什么会出现此错误：/

标签： typescriptexpresswinstoncompiledmorgan

解决方案

好的，所以我深入研究了代码和打字稿文件，以了解它真正需要做什么。

我改变了我的logger.stream声明

// If I don't use the stream.Duplex, it cause another lint error.
logger.stream = (options?: any) => new stream.Duplex({
  write: function (message: string, encoding: any) {
      logger.info(message.trim());
  }
});

至

// Don't forget this import
import { Options } from 'morgan';

// And the code
export const morganOption: Options = {
  stream: {
    write: function (message: string) {
        logger.info(message.trim());
    },
  },
};

然后我导入morganOptions并将其设置为morgan

// My import
import { logger, morganOption } from './logger/index';

// ... Then later, the new code
this.expressApp.use(morgan('combined', morganOption));

希望它可以帮助别人:)

推荐阅读