https://github.com/greylocklabs/teapot

Utilities for working with HTTP status codes, errors, and more
https://github.com/greylocklabs/teapot

error-handling http http-server javascript js koa nodejs npm

Last synced: 5 days ago
JSON representation

Utilities for working with HTTP status codes, errors, and more

• Host: GitHub
• URL: https://github.com/greylocklabs/teapot
• Owner: greylocklabs
• License: mit
• Created: 2017-11-15T22:32:46.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-23T22:36:16.000Z (almost 2 years ago)
• Last Synced: 2024-10-08T05:57:36.931Z (about 1 month ago)
• Topics: error-handling, http, http-server, javascript, js, koa, nodejs, npm
• Language: TypeScript
• Homepage: https://npmjs.org/package/node-teapot
• Size: 3.49 MB
• Stars: 14
• Watchers: 3
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Teapot

> Utilities for working with HTTP status codes, errors, and more.

[![npm version](https://badge.fury.io/js/node-teapot.svg)](https://badge.fury.io/js/node-teapot)

[![build status](https://travis-ci.org/greylocklabs/teapot.svg?branch=master)](https://travis-ci.org/greylocklabs/teapot)

[![coverage status](https://coveralls.io/repos/github/greylocklabs/teapot/badge.svg?branch=master)](https://coveralls.io/github/greylocklabs/teapot?branch=master)

---

Teapot is an HTTP utility library for JavaScript, which leverages the

[Node.js HTTP library](https://nodejs.org/api/http.html). It provides the following:

1. The ability to get an HTTP status code: `teapot.status(404)` and `teapot.status('not found')` would both

   return `404`.

2. Useful error classes to represent HTTP error codes:

    - `HTTPError`: Base class to represent an HTTP error

    - `ClientError` and `ServerError`: Classes to represent 4xx and 5xx errors

    - Classes for every unique HTTP error status code, ranging from `NotImplementedError` to `PaymentRequiredError`

3. A function to generate one of the HTTP error classes from a status code: `teapot.error(404)` would return an

   instance of `NotFoundError`. Great when handling responses from third-party APIs, when you might not know what

   status codes to expect all the time.

TypeScript definitions are included as well.

## Installation

With `yarn`:

```bash

$ yarn add node-teapot

```

With `npm`:

```bash

$ npm install node-teapot

```

## Usage

### Get a status code

There are a variety of ways to get a status code from a number or string message:

```js

teapot.status.code(404); // 404

teapot.status.code('not implemented'); // 405

teapot.status.codes['BAD GATEWAY']; // 502

teapot.status.MOVED_PERMANENTLY; // 301

```

### Get a canned status message

```js

teapot.status[200]; // "OK"

```

### Create an HTTP error

Teapot's errors are compatible with Koa and Express:

```js

throw new teapot.InternalServerError('Oops! Something went wrong.');

```

### Generate an error from a status code

```js

teapot.error(500) // returns instance of InternalServerError

teapot.error(204) // throws error because 204 is not an error code

teapot.error(404, 'My custom message', { // custom message w/ misc. additional properties

   expose: true,

   data: {

      misc: 'blah',

   },

})

```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

## License

MIT License. See [LICENSE](LICENSE) file for details.