# http-exception

> An http exception library

Latest version **0.0.2** (published 2018-04-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install http-exception
pnpm add http-exception
yarn add http-exception
bun add http-exception
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2018-04-17 |
| First published | 2018-04-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Vedran Burdzovic |
| Maintainers | vedb |
| Keywords | http, error, exception |

## Links

- npm: https://www.npmjs.com/package/http-exception
- Repository: https://github.com/vedb/http-exception
- Homepage: https://github.com/vedb/http-exception#readme
- Issues: https://github.com/vedb/http-exception/issues
- npm.io page: https://npm.io/package/http-exception

## 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

- 0.0.2 (latest) — 2018-04-17
- 0.0.1 — 2018-04-16

## README

# HttpException

> HttpException is a small, easy-to-use, and dependency-free HTTP error library for Node.

(Exceptions vs Errors)[https://nodejs.org/api/errors.html#errors_exceptions_vs_errors]

## Features

HttpException improves the error handling experience while matching the
familiar JavaScript native Error object API. It comes with support for creating
custom error objects and with sensible defaults. Use the available HTTP status
code functions to create status-specific errors. All status codes included in
Node's http moddule are supported.

(Node's http module)[https://nodejs.org/api/http.html]

* Familiar native Error API
* Small size (~2 KB)
* No third-party dependencies
* Uses Node's http module's status codes
* Well-tested

## Install

Using npm:

```
npm install --save http-exception
```

Once installed, import and use:

```
const HttpException = require('http-exception')

// via the HttpException class
const errorOne = new HttpException()

// via the createError factory
const errorTwo = HttpException.createError()

// via HttpException's static HTTP methods
const errorThree = HttpException.internalServerError()

throw errorOne
```

## API

### new HttpException([message])

* `message` { String }

Creates a new HttpException object with the supplied message.

### HttpException.createError([options])

* `options` { Object }

Returns an instance of HttpException with the supplied properties.

### HttpException[httpStatusType]([message])

* `message` { String }

Returns an instance of HttpException with the supplied message.

## Todo

HttpException is still a work in progress. Although a well-tested basic level
of functionality is available now, a list of outstanding items and features to
complete is below:

1. Implement a standard mechanism to add custom static exception methods.
2. Consider enabling the customization/initialization of the error objects returned by
   HttpException.
3. Consider exposing elements of `status`.
4. Consider making the library isomorphic.
5. Write tests for stack trace filtering.

## Bugs and feature requests

Have a bug or feature request? (Please open a new issue)[https://github.com/vedb/http-exception/issues/new]

## Licence

[MIT](https://github.com/vedb/http-exception/blob/master/LICENSE)

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