Alexandro.Net

Version 1.0.2

@stackline/fault

Functional errors with formatted output

Independent maintenance of fault 2.0.1. Original authors and licenses are retained.

Installation

# Preserve existing imports with an npm alias
npm install fault@npm:@stackline/fault@1.0.2
# Or use the scoped package name in your imports
npm install @stackline/fault@1.0.2

Node.js: See compatibility notes. Read the compatibility and maintenance notes before migrating.

Usage and API

@stackline/fault

Functional errors with formatted output.

npm version license GitHub repository Docs Reddit community

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

@stackline/fault is the Stackline-maintained distribution of fault@2.0.1. It is an independent continuation of fault; original authors and licenses remain credited below.

Compatibility

Item Value
Package @stackline/fault@1.0.2
API target fault@2.0.1
Supported Node.js See supported framework requirements
License MIT
Module type module
Main entry index.js
Types index.d.ts
Runtime dependencies format

Installation

npm install @stackline/fault

Preserve existing imports and plugin resolution with an npm alias:

npm install fault@npm:@stackline/fault

Usage and API reference

fault

Functional errors with formatted output.

Contents

What is this?

This package adds printf-like interpolation to errors.

When should I use this?

This package useful when you frequently display parameters in error messages and manual string concatenation is becoming verbose.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install @stackline/fault

In Deno with Skypack:

import {fault} from 'https://cdn.skypack.dev/fault@2?dts'

In browsers with Skypack:

<script type="module">
  import {fault} from 'https://cdn.skypack.dev/fault@2?min'
</script>

Use

import {fault} from '@stackline/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 '@stackline/fault'

throw fault.type('Who doesn’t like %f? 🍰', 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 and create. There is no default export.

fault(format?[, values…])

Create an error with a printf-like formatted message.

Parameters
Returns

An Error instance.

Formatters

The following formatters are supported in format:

See samsonjs/format for argument parsing.

Other errors

create(Constructor)

Factory to create instances of ErrorConstructor with support for formatting. Used internally to wrap the global error constructors and exposed for custom errors. Returns a function just like fault.

Types

This package is fully typed with TypeScript. There are no extra exported types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

Related

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer

Credits and original authors

Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.

Community and Links

Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.

Upstream issues and maintenance review

Upstream and maintenance review

This package maintains fault@2.0.1 under the independent @stackline/fault name.

Issue triage

The queried open-issue list contained no issue entries. This does not establish that the upstream is abandoned or bug-free. No runtime bug fix is claimed for this initial maintenance release.

The evidence query fetched the latest 100 open and 30 closed issue/PR entries and removed PRs. Closed entries were collected for context; this report does not claim an exhaustive historic review.

Release discipline

The source commit, passing CI and CodeQL, reviewed CI tarball hash, npm provenance, normal and aliased installs, and immutable GitHub release are checked before a release is complete. Published versions and tags are never replaced.

Release changes

Changelog

1.0.0

Release files and references

Package bytes, npm provenance and the immutable GitHub release were verified for this version. Security checks describe the reviewed release; documented compatibility risks and upstream reports are not blanket claims of resolution.