# know-your-http-well

> HTTP headers, media-types, methods, relations and status codes, all summarized and linking to their specification.

Latest version **0.5.0** (published 2016-09-09) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install know-your-http-well
pnpm add know-your-http-well
yarn add know-your-http-well
bun add know-your-http-well
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2016-09-09 |
| First published | 2013-05-01 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2453 |
| Maintainers | andreineculau |
| Keywords | http, rfc, json |

## Links

- npm: https://www.npmjs.com/package/know-your-http-well
- Repository: https://github.com/andreineculau/know-your-http-well
- Homepage: https://github.com/andreineculau/know-your-http-well#readme
- Issues: https://github.com/andreineculau/know-your-http-well/issues
- npm.io page: https://npm.io/package/know-your-http-well

## Dependencies (1)

- [amdefine](https://npm.io/package/amdefine.md) ~0.0.4

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.5.0 (latest) — 2016-09-09
- 0.2.0 — 2014-06-08
- 0.1.5 — 2013-11-26
- 0.1.4 — 2013-11-13
- 0.1.3 — 2013-10-13
- 0.1.2 — 2013-09-27
- 0.1.1 — 2013-09-08
- 0.1.0 — 2013-07-05
- 0.0.4 — 2013-07-04
- 0.0.3 — 2013-07-04
- 0.0.2 — 2013-07-04
- 0.0.1 — 2013-05-01

## README

# KNOW YOUR HTTP * WELL

HTTP encodings, headers, media types, methods, relations and status codes, all summarized and linking to their specification.

This project is used by [HyperREST bin](https://github.com/andreineculau/hyperrest-bin) at [bin.hyperrest.com](http://bin.hyperrest.com) .


## Table of Contents

- [SPECS](specs.md)
- [ENCODINGS](encodings.md)
- [HEADERS](headers.md)
- MEDIA TYPES
- [METHODS](methods.md)
- [RELATIONS](relations.md)
- [STATUS CODES](status-codes.md)


## How to convert to other formats

* [pandoc](http://johnmacfarlane.net/pandoc/)
* [Marked](http://markedapp.com/)
* ...


## Packages

### Emacs

```emacs
(require 'know-your-http-well)
;; M-x http-header ;; content-type
;; M-x http-method ;; post | POST
;; M-x http-relation ;; describedby
;; M-x http-status-code ;; 500
;; M-x http-status-code ;; not_found | NOT_FOUND
```

### JavaScript

```javascript
var httpWell = require('know-your-http-well'),
    statusWell = httpWell.statusPhrasesToCodes,
    phraseWell = httpWell.statusCodesToPhrases;

// on the server side
res.statusCode = statusWell.NOT_FOUND

// on the client side
if (res.statusCode !== statusWell.OK) {
    // Log "Request returned 404 Not Found"
    log('Request returned ' + res.statusCode + ' ' + phraseWell[res.statusCode]);
}
```

### JSON

Just take a look at [./json/*.json](json).

## License

[Unlicense](LICENSE).

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