Luke Childs 83eddd806d Swap string/object header examples round		8 years ago
src	Use Expires headers if we don't have Cache-Control	8 years ago
test	Use different dates for Date/Expires headers so bugs don't slip through	8 years ago
.gitignore	Extract expired from onionoo-node-client	8 years ago
.travis.yml	Extract expired from onionoo-node-client	8 years ago
LICENSE	Extract expired from onionoo-node-client	8 years ago
README.md	Swap string/object header examples round	8 years ago
package.json	1.1.0	8 years ago

README.md

expired

Calculate when HTTP responses expire from the cache headers

expired accepts HTTP headers as an argument and will return information on when the resource will expire. Cache-Control and Expires headers are supported, if both exist Cache-Control takes priority.

Install

npm install --save expired

Usage

const expired = require('expired');

const headers = `
Access-Control-Allow-Origin: *
Age: 0
Cache-Control: public, max-age=300
Content-Encoding: gzip
Content-Type: application/json;charset=utf-8
Date: Fri, 23 Dec 2016 05:50:31 GMT
Last-Modified: Fri, 23 Dec 2016 05:23:23 GMT
Vary: Accept-Encoding, User-Agent
Via: 1.1 varnish-v4`;

expired(headers)
// false

expired.in(headers)
// 500000

expired.on(headers)
// Date('2016-12-23T05:55:31.000Z')

delay(600000).then(() => {

  expired(headers)
  // true

  expired.in(headers)
  // -100000

  expired.on(headers)
  // Date('2016-12-23T05:55:31.000Z')

});

Response headers are parsed into an object by many HTTP modules. expired will also accept a parsed header object:

const expired = require('expired');

const headers = {
  'access-control-allow-origin': '*',
  'age': '0',
  'cache-control': 'public, max-age=300',
  'content-encoding': 'gzip',
  'content-type': 'application/json;charset=utf-8',
  'date': 'Fri, 23 Dec 2016 05:50:31 GMT',
  'last-modified': 'Fri, 23 Dec 2016 05:23:23 GMT',
  'vary': 'Accept-Encoding, User-Agent',
  'via': '1.1 varnish-v4'
};

expired(headers)
// false

API

expired(headers)

Returns a boolean relating to whether the resource has expired or not. true means it's expired, false means it's fresh.

expired.in(headers)

Returns the amount of milliseconds from the current date until the resource will expire. If the resource has already expired it will return a negative integer.

expired.on(headers)

Returns a JavaScript Date object for the date the resource will expire.