headary

    2.0.0 • Public • Published

    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.

    Build Status

    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.

    Exports

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

    headary(res)

    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 do:

    $ npm install headary
    

    License

    MIT License

    Install

    npm i headary

    DownloadsWeekly Downloads

    3

    Version

    2.0.0

    License

    MIT

    Last publish

    Collaborators

    • avatar