process-warning
A small utility for creating warnings and emitting them.
Last updated 2 years ago
by matteo.collina
.
MIT
·
Repository
·
Bugs
·
Original npm
·
Tarball
·
package.json
$ gnpm install process-warning
SYNC missed versions from
official npm registry.
process-warning
A small utility for generating consistent warning objects across your codebase. It also exposes a utility for emitting those warnings, guaranteeing that they are issued only once.
This module is used by the Fastify framework and it was called fastify-warning prior to version 1.0.0.
Install
npm i process-warning
Usage
The module exports a builder function that returns a utility for creating warnings and emitting them.
const warning = require('process-warning')()
Methods
warning.create(name, code, message)
name(string, required) - The error name, you can access it later witherror.name. For consistency, we recommend prefixing module error names with{YourModule}Warningcode(string, required) - The warning code, you can access it later witherror.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.
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 only once.
warning.emit(code [, a [, b [, c]]])
code(string, required) - The warning code you intend to emit.[, a [, b [, c]]](any, optional) - Parameters for string interpolation.
const warning = require('process-warning')()
warning.create('FastifyWarning', 'FST_ERROR_CODE', 'message')
warning.emit('FST_ERROR_CODE')
How to use an interpolated string:
const warning = require('process-warning')()
warning.create('FastifyWarning', 'FST_ERROR_CODE', 'Hello %s')
warning.emit('FST_ERROR_CODE', 'world')
The module also exports an warning.emitted Map, which contains all the warnings already emitted. Useful for testing.
const warning = require('process-warning')()
warning.create('FastifyWarning', 'FST_ERROR_CODE', 'Hello %s')
console.log(warning.emitted.get('FST_ERROR_CODE')) // false
warning.emit('FST_ERROR_CODE', 'world')
console.log(warning.emitted.get('FST_ERROR_CODE')) // true
License
Licensed under MIT.
Current Tags
- 2.1.0 ... latest (2 years ago)