Winston自定义日志级别打字稿定义

时间:2018-11-14 10:45:28

标签: typescript winston

我正在研究节点应用程序并使用Typescript。 我有温斯顿3。 在我的代码中,我添加了自定义日志级别;

const myCustomLevels = {
    levels: {
        data: 10,
        protocol: 9,
        debug: 8,
        info: 7,
        notice: 6,
        note: 5,
        warn: 4,
        error: 3,
        crit: 2,
        alert: 1,
        emerg: 0,
    }
}

然后

const logger = winston.createLogger({
    level: data,
    levels: myCustomLevels.levels,
    format: winston.format.combine(
        winston.format.json()
    ),
    transports: [new winston.transports.Console()],
});

我需要帮助的问题是当我使用记录器Typescript抱怨时。

logger.protocol({});

在这种情况下,类型为const logger: winston.Logger,ts表示[ts] Property 'protocol' does not exist on type 'Logger'. [2339]。 Typescript不知道我的水平。

如何更正此问题,以便tsc了解记录仪上的我的水平?

1 个答案:

答案 0 :(得分:1)

不幸的是,当前编写的定义不允许自定义日志级别。最简单的解决方案是将返回的记录器转换为包含额外方法的类型的记录器和交集。我们可以使用映射类型Recordkeyof

根据您的const声明创建此类型。
import * as winston from 'winston'
const logger = winston.createLogger({
    level: data,
    levels: myCustomLevels.levels,
    format: winston.format.combine(
        winston.format.json()
    ),
    transports: [new winston.transports.Console()],
}) as winston.Logger & Record<keyof typeof myCustomLevels['levels'], winston.LeveledLogMethod>;

logger.protocol({})

请注意,我一直在增加现有的模块定义,但是由于createLogger被声明为具有内联函数签名的变量,因此我们无法真正通过扩展来扩展它。

如果这是您的一般问题,则可以编写一个保留级别的通用函数:

function createWinstonLogger<T>(options?: Pick<winston.LoggerOptions, Exclude<keyof winston.LoggerOptions, 'levels'>> & { levels: T }) {
    return winston.createLogger(options) as winston.Logger & Record<keyof T, winston.LeveledLogMethod>
}
const logger = createWinstonLogger({
    level: data,
    levels: myCustomLevels.levels,
    format: winston.format.combine(
        winston.format.json()
    ),
    transports: [new winston.transports.Console()],
});
logger.protocol({})