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.
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...])
β EvalErrorfault.range(format?[, values...])
β RangeErrorfault.reference(format?[, values...])
β ReferenceErrorfault.syntax(format?[, values...])
β SyntaxErrorfault.type(format?[, values...])
β TypeErrorfault.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
.
License
MIT Β© Titus Wormer