http-response-status

HTTP Status Map


Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

$3

Using npm:

``
npm i http-response-status
`

Using yarn:

`
yarn add http-response-status
`

Usage

Here are examples of how you can use http-response-status.

$3

`ts
import { NHttpStatuses } from 'http-response-status'

const isOk = (httpCode: number) => {
if (httpCode === NHttpStatuses.OK) {
return true
}

return false
}
`

$3

`ts
import { getHttpStatusName } from 'http-response-status'

const isOk = (httpCode: number) => {
if (getHttpStatusName(httpCode) === 'OK') {
return true
}

return false
}
`

$3

`ts
import { HTTP_STATUS_SUCCESS, getHttpStatusCategory } from 'http-response-status'

const isSuccess = (httpCode: number) => {
if (getHttpStatusCategory(httpCode) === HTTP_STATUS_SUCCESS) {
return true
}

return false
}
`

Running the tests

Tests are written with jest

$3

`
yarn run lint
`

$3

`
yarn run test
``

Deployment

Deployment is done with Travis.

Built With

* TSDX - TSDX

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Arnaud Zheng - Initial work* - arnaud-zg

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details