Skip to content

Utility package that exports a single object with http codes organized by category, and provides information through jsdocs

License

Notifications You must be signed in to change notification settings

rafa-lopes-pt/simple-http-codes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

simple-http-codes

Tired of having to look up the correct http response code? Well now you can easily find out the appropriate code without leaving your IDE 🥳.

No more returning 500🛑 for every error.

This package simply defines a namespace for HTTPCodes, grouping them in their category, and provides jsdocs with a short description and link for more information. All information is based on the RFC 9110 : HTTP Semantics 📖

  • Clutter free 🧹
  • 100% Developer Friendly 🖥️

Usage 🧰

Simply install the npm package, import the HTTPCodes object...and use it! It's that simple :)

NPM Package

npm i simple-http-codes

demo

JsDocs 📓

Each HTTP Code has a jsdoc with:

  • a brief description of it's usage
  • a link providing detailed information
  • an optional "related" field for ambiguous status codes
    • i.e. Code 200 represents a successful response, but it may be more meaningful to use 201 or 204

About

Utility package that exports a single object with http codes organized by category, and provides information through jsdocs

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published