node-teapot
v3.1.1
Published
Utilities for working with HTTP status codes, errors, and more
Downloads
96
Maintainers
Readme
Teapot
Utilities for working with HTTP status codes, errors, and more.
Teapot is an HTTP utility library for JavaScript, which leverages the Node.js HTTP library. It provides the following:
- The ability to get an HTTP status code:
teapot.status(404)
andteapot.status('not found')
would both return404
. - Useful error classes to represent HTTP error codes:
HTTPError
: Base class to represent an HTTP errorClientError
andServerError
: Classes to represent 4xx and 5xx errors- Classes for every unique HTTP error status code, ranging from
NotImplementedError
toPaymentRequiredError
- A function to generate one of the HTTP error classes from a status code:
teapot.error(404)
would return an instance ofNotFoundError
. 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
:
$ yarn add node-teapot
With npm
:
$ 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:
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
teapot.status[200]; // "OK"
Create an HTTP error
Teapot's errors are compatible with Koa and Express:
throw new teapot.InternalServerError('Oops! Something went wrong.');
Generate an error from a status code
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 for guidelines.
License
MIT License. See LICENSE file for details.