fault
Functional errors with formatted output.
Installation
npm:
npm install fault
Usage
var fault = require('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:
var fault = require('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
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...])
— EvalError -
fault.range(format?[, values...])
— RangeError -
fault.reference(format?[, values...])
— ReferenceError -
fault.syntax(format?[, values...])
— SyntaxError -
fault.type(format?[, values...])
— TypeError -
fault.uri(format?[, values...])
— URIError
fault.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
.