http-status-descriptions
v1.0.9
Published
A npm package that provides human-readable descriptions for HTTP status codes.
Downloads
51
Maintainers
Readme
http-status-descriptions
A npm package that provides human-readable descriptions for HTTP status codes.
Installation
You can install this package using npm or yarn.
npm
npm i http-status-descriptions
yarn
yarn add http-status-descriptions
Usage
Here is a simple example to get you started:
import { getStatusDescription } from 'http-status-descriptions';
const description = getStatusDescription(200);
console.log(description);
// Output: OK: The request was successful.
Scripts
Build
To compile the TypeScript files to JavaScript, run:
npm run build
Test
To run tests, use:
npm run test
Configuration
TypeScript Configuration
This package uses a tsconfig.json
file for TypeScript configuration. Here is an example:
{
"compilerOptions": {
"target": "ES6",
"module": "commonjs",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true,
"outDir": "./dist"
},
}
Contributing
Support
LICENSE
This project is licensed under the MIT License - see the LICENSE file for details.