Package Exports
- fault
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fault) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
fault
Functional errors with formatted output.
Install
This package is ESM only: Node 12+ is needed to use it and it must be imported
instead of required.
npm:
npm install faultUse
import fault from 'fault'
throw fault('Hello %s!', 'Eric')Yields:
Error: Hello Eric!
at FormattedError (~/node_modules/fault/index.js:30:12)
at Object.<anonymous> (~/example.js:3:7)
…Or, format a float in a type error:
import fault from 'fault'
throw fault.type('Who doesn’t like %f? \uD83C\uDF70', Math.PI)Yields:
TypeError: Who doesn’t like 3.141593? 🍰
at Function.FormattedError [as type] (~/node_modules/fault/index.js:30:12)
at Object.<anonymous> (~/example.js:3:7)API
This package exports the following identifiers: fault, create.
There is no default export.
fault(format?[, values…])
Create an error with a printf-like formatted message.
Parameters
format(string, optional)values(*, optional)
Formatters
%s— String%b— Binary%c— Character%d— Decimal%f— Floating point%o— Octal%x— Lowercase hexadecimal%X— Uppercase hexadecimal%followed by any other character, prints that character
See samsonjs/format for argument parsing.
Returns
An instance of Error.
Other errors
fault.eval(format?[, values…])— EvalErrorfault.range(format?[, values…])— RangeErrorfault.reference(format?[, values…])— ReferenceErrorfault.syntax(format?[, values…])— SyntaxErrorfault.type(format?[, values…])— TypeErrorfault.uri(format?[, values…])— URIError
create(Constructor)
Factory to create instances of ErrorConstructor with support for formatting.
Used internally to wrap the global error constructors, exposed for custom
errors.
Returns a function just like fault.