process-warning

Install

npm i process-warning

Usage

The module exports a builder function that returns a utility for creating warnings and emitting them.

1const warning = require('process-warning')()

Methods

warning.create(name, code, message[, options])

• name (string, required) - The error name, you can access it later with error.name. For consistency, we recommend prefixing module error names with {YourModule}Warning
• code (string, required) - The warning code, you can access it later with error.code. For consistency, we recommend prefixing plugin error codes with {ThreeLetterModuleName}_, e.g. FST_. NOTE: codes should be all uppercase.
• message (string, required) - The warning message. You can also use interpolated strings for formatting the message.
• options (object, optional) - Optional options with the following properties:
  • unlimited (boolean, optional) - Should the warning be emitted more than once? Defaults to false.

warning.createDeprecation(code, message[, options])

This is a wrapper for warning.create. It is equivalent to invoking warning.create with the name parameter set to "DeprecationWarning".

Deprecation warnings have extended support for the Node.js CLI options: --throw-deprecation, --no-deprecation, and --trace-deprecation.

warning.emit(code [, a [, b [, c]]])

The utility also contains an emit function that you can use for emitting the warnings you have previously created by passing their respective code. A warning is guaranteed to be emitted at least once.

• code (string, required) - The warning code you intend to emit.
• [, a [, b [, c]]] (any, optional) - Parameters for string interpolation.

1const warning = require('process-warning')()
2warning.create('FastifyWarning', 'FST_ERROR_CODE', 'message')
3warning.emit('FST_ERROR_CODE')

How to use an interpolated string:

1const warning = require('process-warning')()
2warning.create('FastifyWarning', 'FST_ERROR_CODE', 'Hello %s')
3warning.emit('FST_ERROR_CODE', 'world')

The module also exports an warning.emitted Map, which contains all the warnings already emitted. Useful for testing.

1const warning = require('process-warning')()
2warning.create('FastifyWarning', 'FST_ERROR_CODE', 'Hello %s')
3console.log(warning.emitted.get('FST_ERROR_CODE')) // false
4warning.emit('FST_ERROR_CODE', 'world')
5console.log(warning.emitted.get('FST_ERROR_CODE')) // true

How to use an unlimited warning:

1const warning = require('process-warning')()
2warning.create('FastifyWarning', 'FST_ERROR_CODE', 'Hello %s', { unlimited: true })
3warning.emit('FST_ERROR_CODE', 'world') // will be emitted
4warning.emit('FST_ERROR_CODE', 'world') // will be emitted again

Suppressing warnings

It is possible to suppress warnings by utilizing one of node's built-in warning suppression mechanisms.

Warnings can be suppressed:

• by setting the NODE_NO_WARNINGS environment variable to 1
• by passing the --no-warnings flag to the node process
• by setting 'no-warnings' in the NODE_OPTIONS environment variable

For more information see node's documentation.

License

Licensed under MIT.