https://github.com/mirusresearch/catbox-disk
Disk storage adapter for catbox
https://github.com/mirusresearch/catbox-disk
catbox catbox-disk disk-storage-adapter hapijs
Last synced: 5 months ago
JSON representation
Disk storage adapter for catbox
- Host: GitHub
- URL: https://github.com/mirusresearch/catbox-disk
- Owner: mirusresearch
- License: other
- Created: 2017-03-22T18:55:04.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-02-11T16:33:38.000Z (over 7 years ago)
- Last Synced: 2026-01-15T17:58:13.914Z (5 months ago)
- Topics: catbox, catbox-disk, disk-storage-adapter, hapijs
- Language: JavaScript
- Size: 29.3 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
catbox-disk [](https://travis-ci.org/mirusresearch/catbox-disk)
=============
Disk storage adapter for [catbox](https://github.com/hapijs/catbox).
Lead Maintainer - [Andrew Hughes](https://github.com/EyePulp)
Code liberally cribbed from various other adapter examples, primarily
- [catbox-memory](https://github.com/hapijs/catbox-memory)
- [catbox-s3](https://github.com/fhemberger/catbox-s3)
### Version Note:
**Users of Hapi less than v17 should use the 2.x.x version of this plugin. For Hapi v17 and above use version 3.x.x or greater.**
### Example invocations:
#### >= Hapi v17.0.0:
```javascript
const Hapi = require('hapi');
const Disk = require('catbox-disk');
const server = new Hapi.Server({
cache : [{
name : 'diskCache',
engine : new Disk({
cachePath: '/some/existing/dir',
cleanEvery: 3600000,
partition : 'cache'
}),
}]
});
```
#### < Hapi v17.0.0:
```javascript
const Hapi = require('hapi');
const Disk = require('catbox-disk');
const server = new Hapi.Server({
cache : [{
name : 'diskCache',
engine : Disk,
cachePath: '/some/existing/dir',
cleanEvery: 3600000,
partition : 'cache'
}]
});
```
### Opttions:
- `cachePath` : `string` **required** - a pre-existing path you want to store your cache files in
- `cleanEvery` : `integer ` **optional** - number of milliseconds between each cache cleanup for disk space recovery. Set to 0 to deactivate entirely.
### Notes:
- This cache backend stores everything in flat `.json` files with MD5 hashed filenames based off the keys to avoid encoding issues & length limits at the filesystem level.
- Initial hash character prefixes are used to split file storage into multiple sub directories to avoid excessive file counts in any one directory, e.g. `ABCD1234DEADBEEF.json` is stored in `.../AB/CD/ABCD1234DEADBEEF.json`
- **This cache doesn't set an upper limit on disk usage.** Plan accordingly, and monitor your free drive space if you're not certain about behavior.
- Old, un-accessed files are automatically purged via the `cleanEvery` interval option, which is active by default. If you never access an old cached file, it will take up drivespace until deleted, which is why this option is important. **Be mindful if you deactivate it**.