@js-thing/http-status-codes
TypeScript icon, indicating that this package has built-in type declarations

1.0.1-beta.2 • Public • Published

npm version Build status codecov GitHub version dependencies dev-dependencies npm-downloads

Http Status Codes

This library is a complete collection of all Http Status Codes and Reason Phrases along with helper functions with no dependencies and is open source written in typescript.

Use with Typescript or Javascript in both server or client side.

Covers status codes defined in

  • Hypertext Transfer Protocol (HTTP/1.0) defined in RFC 1945
  • Hypertext Transfer Protocol (HTTP/1.1) defined in RFC 2616
  • Web-based Distributed Authoring and Versioning (WebDAV) defined in RFC 2518

View project on GitHub


Documentation

Each and every member/property/function of the library are properly documented to get comprehensive inforation along with supporting links to original sources.

An example of VS Code IntelliSense showing the Unauthorized enum member.

image

The complete documentation of this project can be found in this link.


Installation

Install from npm

npm install @js-thing/http-status-codes

Import it to your project

Import the library to your project

import HttpStatusCodes, { 
    HttpInformationStatusCodes, 
    HttpSuccessStatusCodes,
    HttpRedirectionStatusCodes,
    HttpClientErrorStatusCodes,     
    HttpServerErrorStatusCodes,
} from '@js-thing/http-status-codes';

Or

const { 
    HttpInformationStatusCodes, 
    HttpSuccessStatusCodes, 
    HttpRedirectionStatusCodes, 
    HttpClientErrorStatusCodes, 
    HttpServerErrorStatusCodes,
    HttpStatusCodes,
} = require('@js-thing/http-status-codes');

Import default using require

const HttpStatusCodes = require('@js-thing/http-status-codes').default;

Usage

The HttpStatusCodes enum is the super set of HttpInformationStatusCodes, HttpSuccessStatusCodes, HttpRedirectionStatusCodes, HttpClientErrorStatusCodes and HttpServerErrorStatusCodes enums,

// use the combined enum to access any status code
const code = HttpStatusCodes.Continue; // code = 100
const code = HttpStatusCodes.Ok; // code = 200
const code = HttpStatusCodes.Found; // code = 302
const code = HttpStatusCodes.BadRequest; // code = 400
const code = HttpStatusCodes.InternalServerError; // code = 500

// Or use the individual enum group
const code = HttpInformationStatusCodes.Continue; // code = 100
const code = HttpSuccessStatusCodes.Ok; // code = 200
const code = HttpRedirectionStatusCodes.Found; // code = 302
const code = HttpClientErrorStatusCodes.BadRequest; // code = 400
const code = HttpServerErrorStatusCodes.InternalServerError; // code = 500

Licence

The documentation for this project is directly sourced from MDN Web Docs by Mozilla Contributors is licensed under CC-BY-SA 2.5

The project excluding the documentation is licenced under MIT

Package Sidebar

Install

npm i @js-thing/http-status-codes

Weekly Downloads

17

Version

1.0.1-beta.2

License

MIT

Unpacked Size

306 kB

Total Files

123

Last publish

Collaborators

  • j-a-k-npm