# nanoerror

> Small module to create code errors with format support.

Latest version **2.0.0** (published 2023-09-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install nanoerror
pnpm add nanoerror
yarn add nanoerror
bun add nanoerror
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-09-25 |
| First published | 2019-10-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | GEUT |
| Maintainers | tinchoz49 |
| Keywords | geut, module, errors |

## Links

- npm: https://www.npmjs.com/package/nanoerror
- Repository: https://github.com/geut/nanoerror
- Homepage: https://github.com/geut/nanoerror#readme
- Issues: https://github.com/geut/nanoerror/issues
- npm.io page: https://npm.io/package/nanoerror

## Dependencies (1)

- [quick-format-unescaped](https://npm.io/package/quick-format-unescaped.md) ^4.0.4

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2023-09-25
- 1.3.4 — 2023-07-22
- 1.3.3 — 2023-07-22
- 1.3.2 — 2023-06-14
- 1.3.1 — 2023-06-12
- 1.3.0 — 2022-10-21
- 1.2.1 — 2020-08-12
- 1.2.0 — 2020-08-12
- 1.1.0 — 2020-03-12
- 1.0.0 — 2019-10-29

## README

# nanoerror

[![Build Status](https://travis-ci.com/geut/nanoerror.svg?branch=master)](https://travis-ci.com/geut/nanoerror)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

> Small module to create code errors with format support.

## <a name="install"></a> Install

```
$ npm install nanoerror
```

## <a name="usage"></a> Usage

```javascript
const createError = require('nanoerror')

const ERR_EXAMPLE = createError('ERR_EXAMPLE', 'An error with the args: %s %j')

try {
  throw new ERR_EXAMPLE('arg1', { somejson: true })
} catch (err) {
  console.log(err.code) // ERR_EXAMPLE
  console.log(err.message) // An error with the args: arg1 {"somejson": true}
}
```

## API

#### `const ERR = createError(code: string, message: string)`

Creates a new nanoerror class.

#### `err.isNanoerror => boolean`

Returns true if the err is a nanoerror instance.

#### `ERR.equals(err) => boolean`

Returns true if the err belongs to a specific nanoerror class.

#### `ERR.from(err) => ERR`

Creates an error based on the options of another one.

## <a name="issues"></a> Issues

:bug: If you found an issue we encourage you to report it on [github](https://github.com/geut/nanoerror/issues). Please specify your OS and the actions to reproduce it.

## <a name="contribute"></a> Contributing

:busts_in_silhouette: Ideas and contributions to the project are welcome. You must follow this [guideline](https://github.com/geut/nanoerror/blob/master/CONTRIBUTING.md).

## License

MIT © A [**GEUT**](http://geutstudio.com/) project

---
_Source: https://npm.io/package/nanoerror · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._