Skip to content

API.md

Latest commit

 

History

History
33 lines (27 loc) · 3.01 KB

API.md

File metadata and controls

33 lines (27 loc) · 3.01 KB

API Reference

Hapi Plugin Options

These are the available options passed into Tacky during plugin registration (server.register).

  • expiresIn - number of milliseconds to keep results in the cache. Also controls the "max-age" cache header. Defaults to 3600000 (one hour).
  • privacy - determines the privacy flag included in client-side caching using the 'Cache-Control' header. Values are:
    • 'default' - no privacy flag. This is the default setting.
    • 'public' - mark the response as suitable for public caching.
    • 'private' - mark the response as suitable only for private caching.
  • cache - name of the cache provision to use if it has already been created by the hapi server. If specified, the cache must already exist before registration. Defaults to the default in-memory hapi cache.
  • bind - context object for hydrate and generateKey. Defaults to undefined.

cache Route Handler Options

  • hydrate - a function used to get data when absent from the cache. Must have the following signature: function (request, callback) where:
    • request - the incoming hapi request
    • callback(err, result[, state]) - function to execute when hydrate is finished.
      • err - any error during processing. If this value is truthy, the request will result in a 500 and the request will not be cached.
      • result - the value to save in the cache and will be used in responses via reply(response).
      • [state] - this value will be attached to request.response.plugins.tacky.state so it will be available during the various request lifecycle methods. Defaults to null. state is also stored in the cache so it should only contain information truly necessary for generating a cached response and should not include any request specific information.
  • [privacy] - override the global privacy setting on a per route basis.
  • [expiresIn] - override the global expiresIn setting on a per route basis.
  • [generateKey(request)] - a function used to generate the cache key. The default value will return request.raw.req.url. If undefined is returned, cache lookup and storage will be completely skipped. All other results must be strings.
    • request - incoming hapi request object.

tacky provides two additional data points throughout the request lifecycle via response.plugins.tacky that can be used outside of the plugin for business specific application.

  • cache - object with the following keys. Will be null if generateKey returns undefined.
    • maxAge - number of milliseconds remaining for this cache record. This value should be used in custom logic outside tacky.
    • ttl - number of milliseconds remaining for this cache record. Will be 0 the first time a record is cached. Using maxAge is preferred because of this.
    • privacy - privacy setting used for the cache header
  • state - object passed into the callback of the hydrate method. Will be null if not provided by the callback to hydrate or if the result is not available in the cache.