[Bug]: type hints say there's a logger.warning() but it does not exist

[kosta]

🔎 Search Terms

warning

The problem

index.d.ts claims Logger has a warning function. Calling that function leads to TypeError: logger.warning is not a function at ....

Please remove the wrong type hint, and potentially everything under // for syslog levels only?

What version of Winston presents the issue?

v3.8.2

What version of Node are you using?

v18.12.1

If this worked in a previous version of Winston, which was it?

No response

Minimum Working Example

Welcome to Node.js v18.12.1.
Type ".help" for more information.
> const winston = require('winston')
undefined
> const logger = winston.createLogger({})
undefined
> logger.warning("oops")
Uncaught TypeError: logger.warning is not a function

Additional information

No response

[wbt]

This probably affects all the rest of the syslog levels, not just warning.
However, adding a .warning() method aliasing .warn() seems like it could be a useful change to accompany #2277.
There's likely a way to do it with existing code user-side via custom log levels, but I'm not sure how well that works with types.

[JavaScriptBach]

Is this project still being maintained? Would you be willing to accept a PR removing incorrect types and push a new release?

We just got bit by this in production, and it seems like a very urgent and easy fix.

[JavaScriptBach]

@wbt I opened #2339

[codazzo]

As the code changes in the fix PR have been reverted (for good reason), this is what I will be resorting to in my current project in order to avoid this issue, which is unfortunately unresolved:

import winston from 'winston';

const logger = winston.createLogger() as Pick<
  winston.Logger,
  'error' | 'warn' | 'info' | 'http' | 'verbose' | 'debug' | 'silly'
>;

Given the polymorphic nature of the winston instance when it comes to log-level-specific method names, I don't know of a better way to address this.