https://github.com/michaelnisi/headary

Summarize HTTP headers
https://github.com/michaelnisi/headary

Last synced: about 1 month ago
JSON representation

Summarize HTTP headers

• Host: GitHub
• URL: https://github.com/michaelnisi/headary
• Owner: michaelnisi
• License: mit
• Created: 2015-06-09T18:30:27.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-09-23T06:30:43.000Z (over 8 years ago)
• Last Synced: 2024-05-02T05:35:40.344Z (8 months ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# headary - summarize HTTP headers

**headary** is a trivial [Node](https://nodejs.org) package that provides a normalized summary of basic HTTP status codes and headers. You might use **headary** to write control flow for `redirects` and `304s` in a uniform way. This can make sense if you handle responses at multiple locations in your code.

[![Build Status](https://secure.travis-ci.org/michaelnisi/headary.svg)](http://travis-ci.org/michaelnisi/headary)

## Example

```js

const headary = require('headary')

// Get HTTP response `res` from somewhere.

const h = headary(res)

if (h.ok) {

  // Move on.

} else {

  if (h.message) {

    // Quaint or unhandled HTTP status.

    const er = new Error(h.message)

    this.emit('error', er)

  } else if (h.url) {

    // Issue request with new URL.

    if (h.permanent) {

      // Update some cache or whatever.

    }

  } else if (h.permanent) {

    // `410: Gone`, update cache.

  } else {

    // `304: Not Modified`, done.

  }

}

```

## Types

### Headers

- `message` `String` Optional information.

- `ok` `Boolean` This flag is `true` if no further actions are required.

- `permanent` `Boolean` If the resource has been moved permanently, this is `true`.

- `url` `String` If the resource has been moved, this is its new location.

## Exports

**headary** exports a single function that returns a new `Headers` object.

### headary(res)

- `res` [`http.IncomingMessage`](https://nodejs.org/api/http.html#http_class_http_incomingmessage) A HTTP response.

Creates `Headers` from a HTTP response.

The considered HTTP status codes:

- `200` OK

- `300` Multiple Choices

- `301` Moved Permanently

- `302` Found

- `303` See Other

- `304` Not Modified

- `305` Use Proxy

- `307` Temporary Redirect

- `410` Gone

## Install

With [npm](https://npmjs.org/package/headary) do:

```

$ npm install headary

```

## License

[MIT License](https://raw.github.com/michaelnisi/headary/master/LICENSE)