# readable-http-codes

> 0 dependency readable HTTP code enums, cleaning up your codebase!

Latest version **1.1.1** (published 2022-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install readable-http-codes
pnpm add readable-http-codes
yarn add readable-http-codes
bun add readable-http-codes
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2022-05-10 |
| First published | 2022-05-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 247.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Arsam Sarabi |
| Maintainers | arsamsarabi |
| Keywords | http, http-status-codes, http-status-codes-enum, status-code, status code |

## Links

- npm: https://www.npmjs.com/package/readable-http-codes
- Repository: https://github.com/arsamsarabi/readable-http-codes
- Issues: https://github.com/arsamsarabi/readable-http-codes/issues
- npm.io page: https://npm.io/package/readable-http-codes

## Recent versions

- 1.1.1 (latest) — 2022-05-10
- 1.1.0 — 2022-05-10
- 1.0.14 — 2022-05-10
- 1.0.13 — 2022-05-10
- 1.0.12 — 2022-05-10
- 1.0.11 — 2022-05-10
- 1.0.10 — 2022-05-10
- 1.0.9 — 2022-05-10
- 1.0.3 — 2022-05-10
- 1.0.2 — 2022-05-10
- 1.0.1 — 2022-05-10
- 1.0.0 — 2022-05-10

## README

# readable-http-codes

0 dependancy, readable HTTP code enums, cleaning up your codebase!

JsDoc written for all the HTTP codes which includes relevant information and links.

Based on the [MDN HTTP response status codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status)

### Install:

```shell
# Using NPM
npm install readable-http-codes

# The better option
yarn add readable-http-codes
```

### Usage:

```typescript
// import all the codes
import { allStatusCodes } from 'readable-http-codes'

res.status(allStatusCodes.SERVICE_UNAVAILABLE).send('Service unavailable')

// Or import just the codes you need
import { SERVICE_UNAVAILABLE } from 'readable-http-codes'

if (response.status === SERVICE_UNAVAILABLE) {
  console.error('Service unavailable')
}
```

```typescript
// utility function to get the status texts from code
import { getStatusText, SERVICE_UNAVAILABLE } from 'readable-http-codes'

console.log(getStatusText(SERVICE_UNAVAILABLE)) // 'Service Unavailable'
console.log(getStatusText(503)) // 'Service Unavailable'

// attach (INFO: | OK: | REDIRECT: | CLIENT ERROR: | SERVER ERROR:) prefixes to the status texts
import { getStatusText, allStatusCodes } from 'readable-http-codes'

console.log(getStatusText(allStatusCodes.SWITCHING_PROTOCOLS, true)) // 'INFO: Switching Protocols'
console.log(getStatusText(101, true)) // 'INFO: Switching Protocols'

console.log(getStatusText(allStatusCodes.OK, true)) // 'OK: OK'
console.log(getStatusText(200, true)) // 'OK: OK'

console.log(getStatusText(allStatusCodes.MOVED_PERMANENTLY, true)) // 'REDIRECT: Moved Permanently'
console.log(getStatusText(301, true)) // 'REDIRECT: Moved Permanently'

console.log(getStatusText(allStatusCodes.TOO_MANY_REQUESTS, true)) // 'CLIENT ERROR: Too Many Requests'
console.log(getStatusText(429, true)) // 'CLIENT ERROR: Too Many Requests'

console.log(getStatusText(allStatusCodes.SERVICE_UNAVAILABLE, true)) // 'SERVER ERROR: Service Unavailable'
console.log(getStatusText(503, true)) // 'SERVER ERROR: Service Unavailable'
```

```typescript
// Miscillaneous
import type { StatusCodes } from 'readable-http-codes'

// type of all valid status codes defined in this package
type StatusCode = 100 | 101 | etc.

import { statusTextMap, statusTextMapWithPrefix } from 'readable-http-codes'

// statusTextMap returns a map of status codes to their status texts
console.log(statusTextMap) // { 200: 'OK', 404: 'Not Found', ... }

// statusTextMapWithPrefix returns a map of status codes to their status texts with prefixes
console.log(statusTextMapWithPrefix) // { 200: 'OK: OK', 404: 'CLIENT ERROR: Not Found', ... }
```

---
_Source: https://npm.io/package/readable-http-codes · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._