# routebox-ft

> Transparent catbox-based response caching for Hapi servers

Latest version **2.0.0** (published 2017-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install routebox-ft
pnpm add routebox-ft
yarn add routebox-ft
bun add routebox-ft
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2017-04-05 |
| First published | 2017-04-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Connor Peet |
| Maintainers | jga |
| Keywords | catbox, hapi, cache, route |

## Links

- npm: https://www.npmjs.com/package/routebox-ft
- Repository: https://github.com/WatchBeam/routebox
- Homepage: https://github.com/WatchBeam/routebox#readme
- Issues: https://github.com/WatchBeam/routebox/issues
- npm.io page: https://npm.io/package/routebox-ft

## Dependencies (3)

- [joi](https://npm.io/package/joi.md) ^9.0.0
- [hoek](https://npm.io/package/hoek.md) ^4.0.1
- [es-hash](https://npm.io/package/es-hash.md) ^1.0.4

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2017-04-05

## README

# Routebox

[![Build Status](https://img.shields.io/travis/WatchBeam/routebox.svg?style=flat-square)](https://travis-ci.org/WatchBeam/routebox)

Routebox integrates with catbox to provide transparent route-level caching. It can work with zero configuration changes on your server.

## Usage

To Routebox, simply register it on your server.

```js
server.register(require('routebox'), function (err) {
    // ...
});
```

By default, all endpoints with the `cache` configured in their [route options](http://hapijs.com/api#route-options) and `privacy` set to `public` (or omitted; public is the default) will be cached. Routebox automatically hooks in to the `expiresAt`, `expiresIn`, and `statuses` options of the caching config.

These options are available when routebox is registered and can also be overridden on a per-route basis by passing in `config.plugins.routebox`:

 * `cache` corresponds to the cache name for response caches. Uses the server's default if not given.
 * `enabled` whether to enable caching on the endpoint. Defaults to `true`, meaning all viable (see above) endpoints will be cached.
 * `digest` defaults to `djb2`, this is the algorithm used to digest the request for caching purposes. Other available options are: `md5`, `sha1`, `sha256`, `sha512`, `ripemd160`.
 * `segment` is the Catbox cache segment to store in. Defaults to `routebox`
 * `wasCachedHeader` header that gets sent down when we serve a cached response. Defaults to `X-Was-Cached`.
 * `parse` configures which parts of the request will be used to form the cache key:
    * `query` whether to include the query string. Defaults to `true`.
    * `method` whether to include the request method. Defaults to `true`.
    * `path` whether to include the route path. Defaults to `true`.
 * `callbacks` provides touch-points you can use to intercept the request and gather metrics. Each callback functions like a Hapi extension, taking the `(request, reply)` as arguments, after which you should call `reply.continue()`. These are called at the `onPreResponse` lifecycle point.
    * `onCacheHit` is called when a cached page is served.
    * `onCacheMiss` is called when a page that could be cached but is not (yet) is served.
    * `auth` will skip caching if a user has been authenticated. Defaults to `false`, meaning always cache regardless of whether there is a request.auth object. 

In addition there is one other setting that can be specified only in `config.plugins.routebox`:

 * `pluginCache` can be used to set cache options instead of config.cache.  So caching works as specified by `config.plugins.routebox.pluginCache`, but cache-control directives aren't sent out to the browser.
If there's an endpoint that can sometimes provide private data, you can call `request.nocache()` to prevent Routebox from caching the request.

---
_Source: https://npm.io/package/routebox-ft · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._