readable-http-status-codes v1.1.3

readable-http-status-codes

By writing readable http status codes your code becomes even more readable and easier to understand.

Some status codes are for most developers clear e.g. 200, 404 or 500. But few developers can tell what 402, 426 or 501 means without looking up. Writing codes that require someone reading it to stop and look something up, should be avoided whenever possible.

This package provides you the full list (see below) of all http status codes available on the nodejs core module http. So you can write

PAYMENT_REQUIRED or PAYMENT_REQUIRED_CODE instead of 402

UPGRADE_REQUIRED or UPGRADE_REQUIRED_CODE instead of 426

NOT_IMPLEMENTED or NOT_IMPLEMENTED_CODE instead of 501

IM_A_TEAPOT or IM_A_TEAPOT_CODE instead of 418

...

And to retrieve the status messages use

PAYMENT_REQUIRED_TEXT to return Payment Required

UPGRADE_REQUIRED_TEXT to return Upgrade Required

NOT_IMPLEMENTED_TEXT to return Not Implemented

IM_A_TEAPOT_TEXT to return I'm a Teapot

...

Intellisense support included (tested in VS Code editor) so you code faster.

Installation

$ npm i readable-http-status-codes

Usage

Require CommonJS (default)

const status_codes = require("readable-http-status-codes");

Import ES-Module (default)

import status_codes from "readable-http-status-codes";

Import ES-Module (named)

import { readable_http_status_codes as status_codes } from "readable-http-status-codes";

Some examples based on express

res.status(status_codes.OK).json({
    /* data */
});

res.sendStatus(status_codes.BAD_REQUEST);

res.sendStatus(status_codes.NO_CONTENT);

List of all keys

It is the full list of all HTTP status codes provided by nodejs core module http.

License

See LICENSE.

Copyright

Copyright © 2022. Kossi D. T. Saka.