Headary NPM | npm.io

headary - summarize HTTP headers

headary is a trivial Node 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.

Example

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.