Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
72 lines (54 sloc) 2.38 KB
title isPro
ttl
true

Type: |
Default:

Establishes the maximum quantity of time a resource served from cache layer is considered as valid.

<MultiCodeEditor languages={{ Shell: microlink-api https://microlink.io&ttl=1d, 'Node.js': `const mql = require('@microlink/mql')

module.exports = async () => { const { status, data, response } = await mql('https://microlink.io', { ttl: '1d' }) console.log(status, data) } ` }} />

The value provided need to be at least 1 minute and not higher than 31 days, being supported the following formats:

  • as number in milliseconds (e.g., ).
  • as humanized representation of the number (e.g., ).

The following humanized number variations are supported:

https://microlink.io&ttl=1d        // 86400000
https://microlink.io&ttl=1day      // 86400000
https://microlink.io&ttl=1days     // 86400000

https://microlink.io&ttl=1h        // 3600000
https://microlink.io&ttl=1hour     // 3600000
https://microlink.io&ttl=1hours    // 3600000

https://microlink.io&ttl=90s       // 90000
https://microlink.io&ttl=90secs    // 90000
https://microlink.io&ttl=90second  // 90000
https://microlink.io&ttl=90seconds // 90000

Additionally, we provide and aliases:

https://microlink.io&ttl=min     // equivalent to `1m`
https://microlink.io&ttl=max     // equivalent to `31d`

The purpose of this API parameter is to adapt our caching layer based on your necessities:

  • If you are targetting an URL that changes very often and response time is not critical for you, a small value will work better.
  • If you are targetting an URL that doesn't change too much or you want to maximize cache hits, getting faster response time, a higher value works better.

The value provided will reflected as x-cache-ttl as part of the response headers

<MultiCodeEditor languages={{ Shell: curl -I -s -X GET https://microlink.io?url=https://www.twitter.com/microlinkhq | grep -i "x-cache-ttl", 'Node.js': `const mql = require('@microlink/mql')

module.exports = async () => { const { status, data, response } = await mql('https://www.reddit.com')

console.log(response.headers.['x-cache-ttl' ) // => '3h 56m 35.2s' } ` }} />

You can’t perform that action at this time.