Skip to content

Commit

Permalink
API docs - give some details about the the 'cache' configuration and …
Browse files Browse the repository at this point in the history
…what happens with catbox
  • Loading branch information
paulovieira committed Jun 16, 2016
1 parent a732711 commit 47d8a5a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,11 @@ Creates a new `Server` object where:
includes a default cache for storing application state. By default, a simple memory-based
cache is created which has limited capacity and capabilities. **hapi** uses
[**catbox**](https://github.com/hapijs/catbox) for its cache which includes support for
common storage solutions (e.g. Redis, MongoDB, Memcached, and Riak). Caching is only utilized
common storage solutions (e.g. Redis, MongoDB, Memcached, Riak, among others). Caching is only utilized
if methods and [plugins](#plugins) explicitly store their state in the cache. The server
cache configuration only defines the storage container itself. `cache` can be assigned:
- a prototype function (usually obtained by calling `require()` on a **catbox** strategy
such as `require('catbox-redis')`).
such as `require('catbox-redis')`). A new **catbox** [client](https://github.com/hapijs/catbox#client) will be created internally using this function.
- a configuration object with the following options:
- `engine` - a prototype function or **catbox** engine object.
- `name` - an identifier used later when provisioning or configuring caching for
Expand Down

0 comments on commit 47d8a5a

Please sign in to comment.