@landmineaknpm/ex-distinctio-illum NPM

@landmineaknpm/ex-distinctio-illum

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 (unless configured otherwise).

This module is used by the Fastify framework and it was called fastify-warning prior to version 1.0.0.

Install

npm i @landmineaknpm/ex-distinctio-illum

Usage

The module exports two builder functions for creating warnings.

const {
  createWarning,
  createDeprecation
} = require('@landmineaknpm/ex-distinctio-illum')

const warning = createWarning({
  name: 'ExampleWarning',
  code: 'EXP_WRN_001',
  message: 'Hello %s',
  unlimited: true
})
warning('world')

Methods

`createWarning({ name, code, message[, unlimited] })`

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.

`createDeprecation({code, message[, options]})`

This is a wrapper for createWarning. It is equivalent to invoking createWarning 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([, a [, b [, c]]])`

The returned warning function can used for emitting warnings. A warning is guaranteed to be emitted at least once.

[, a [, b [, c]]] (any, optional) - Parameters for string interpolation.

const { createWarning } = require('@landmineaknpm/ex-distinctio-illum')
const FST_ERROR_CODE = createWarning({ name: 'MyAppWarning', code: 'FST_ERROR_CODE', message: 'message' })
FST_ERROR_CODE()

How to use an interpolated string:

const { createWarning } = require('@landmineaknpm/ex-distinctio-illum')
const FST_ERROR_CODE = createWarning({ name: 'MyAppWarning', code: 'FST_ERROR_CODE', message: 'Hello %s'})
FST_ERROR_CODE('world')

The warning object has methods and properties for managing the warning's state. Useful for testing.

const { createWarning } = require('@landmineaknpm/ex-distinctio-illum')
const FST_ERROR_CODE = createWarning({ name: 'MyAppWarning', code: 'FST_ERROR_CODE', message: 'Hello %s'})
console.log(FST_ERROR_CODE.emitted) // false
FST_ERROR_CODE('world')
console.log(FST_ERROR_CODE.emitted) // true

const FST_ERROR_CODE_2 = createWarning('MyAppWarning', 'FST_ERROR_CODE_2', 'Hello %s')
FST_ERROR_CODE_2.emitted = true
FST_ERROR_CODE_2('world') // will not be emitted because it is not unlimited

How to use an unlimited warning:

const { createWarning } = require('@landmineaknpm/ex-distinctio-illum')
const FST_ERROR_CODE = createWarning({ name: 'MyAppWarning', code: 'FST_ERROR_CODE', message: 'Hello %s', unlimited: true })
FST_ERROR_CODE('world') // will be emitted
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.

stable stringifier filter code points events Array dataview signal fullwidth last RegExp#flags es2016 xdg callback query spawn consume _.extend autoprefixer opens curried bundler spinner look-up zero util.inspect tacit react-hook-form lint prune assertion console es8 bdd writable launch argument from regular expressions nested css Int8Array rm extend browser dom-testing-library warning libphonenumber joi Stream callbind typeerror crypt regex URLSearchParams mkdirp option animation ECMAScript 2019 ES5 symbol time child data es-shims linux tdd URL iterate gradients css3 ES2018 6to5 BigInt64Array properties postcss ES2021 findLast mimetypes airbnb idle delete karma status babel-core io-ts task scheme metadata install user-streams xterm ecmascript less css helpers call AsyncIterator react-testing-library class-validator require wordbreak js pose electron proto sameValueZero compare runtime fs RxJS urls mocha efficient bound ArrayBuffer -0 rm -rf starter streams2 bind tc39 assign language rmdir Microsoft apollo performance ender ES3 positive findLastIndex chrome iteration deep-copy jsx Object.values dependency manager bootstrap css ES2015 worker symlink flag private chai robust ES6 ast values command wrap packages polyfill BigUint64Array classnames get minimal jsonpath typeof ECMAScript 2022 watch patch full nodejs spring ramda ratelimit styled-components Array.prototype.flatten deepcopy es-shim API fast-deep-copy progress package manager shell slot assert Promise defineProperty folder editor setPrototypeOf Object.defineProperty descriptors toobject hookform setImmediate asserts collection.es6 logging Symbol.toStringTag censor push styles babel full-width higher-order es6 channel exec Array.prototype.findLast less gdpr array Object.keys symbols accessibility yaml mime-db check react animation estree react pose flags JSON HyBi superstruct a11y spec core es weakset css-in-js equality getintrinsic wordwrap interrupts ReactiveExtensions matchAll zod password Array.prototype.flatMap argv superagent Object.entries group styling installer ES2017 ie shim sorted Array.prototype.flat https deep windows fast-clone json-schema-validator getopt type ES2019 promises connect deepclone regular process concat valid fixed-width picomatch JSON-Schema syntax debugger remove buffers wait monorepo command-line graphql east-asian-width typescript stylesheet streams persistent Uint8Array trim ESnext 256 Array.prototype.contains visual term es2018 Object.is Object.assign TypedArray flat up i18n auth hasOwn tslib functional debug rfc4122 limited npm columns colors multi-package Int32Array ponyfill validate optimist recursive crypto getOwnPropertyDescriptor json sanitization RegExp.prototype.flags byteLength formatting enumerable resolve awesomesauce sharedarraybuffer telephone sort limit WeakMap ECMAScript 2016 shebang prototype entries irq url [[Prototype]]Array.prototype.includes argparse make getPrototypeOf validator typed array TypeScript merge parse WeakSet api name set ajax function getter rm -fr configurable break start reduce serialize serializer batch promise invariant uuid __proto__transpiler WebSocket jsdiff sequence drag ES2022 listeners date $.extend phone read reducer Object.fromEntries Reflect.getPrototypeOf intrinsic util linewrap shrinkwrap sigint core-js gradients css point-free curl loading Float32Array stringify ES qs commander emoji arraybuffer codes key macos immutable path transpile variables in css schema private data scheme-validation var write handlers config ajv Float64Array utilities optimizer watchFile pyyaml fastify forEach preprocessor trimStart RFC-6455 safe bootstrap less find weakmap CSSStyleDeclaration datastructure quote duplex fsevents test hooks watcher lesscss modules fetch toSorted tools json-schema-validation offset file arrays middleware clone ascii plugin es7 app characters property sanitize compiler copy Object.getPrototypeOf functions once fp colour testing korean postcss-plugin readable guid cors typedarray ES7 groupBy bundling view form framer Rx sigterm javascript l10n ECMAScript 2018 file system text es5 shared map Function.prototype.name eslintconfig xhr mime YAML operating-system diff random ECMAScript 5 tap pipe negative eventDispatcher search react-hooks http uninstall args lockfile popmotion prefix throttle internal error performant callbound rangeerror immer jest stdlib String.prototype.matchAll eslint-plugin encryption style width WebSockets cjk deterministic ECMAScript 7 es2015 rapid ECMAScript 3 figlet .env spinners stream mkdirs call-bound slice ReactiveX collection length jsdom value touch japanese browserslist Symbol readablestream findup less compiler bcrypt fantasy-land jQuery speed environment indicator coercible toolkit omit Observables protocol-buffers prop eslint error-handling logger opener syntaxerror accessor chinese watching define module jsonschema match env compile less unicode web real-time chromium ES8 art pnpm9 utils browserlist framework exit parent typesafe setter tester negative zero arktype includes busy waapi const querystring hardlinks xdg-open drop move open emit fast-deep-clone eventEmitter string has trimEnd fastcopy traverse circular regexp executable trimRight inference exit-code link flatten harmony dependencies computed-types mixins trimLeft async Push look jwt serialization tty rate glob dir isConcatSpreadable concatMap gestures Uint16Array ES2016 package css nesting color queueMicrotask styleguide

@ryniaubenpm/esse-repellat-excepturi @zibuthe7j11/deserunt-quasi-impedit @zibuthe7j11/vel-impedit-modi

1.0.0

13 days ago