Wondering what’s next for npm?Check out our public roadmap! »

    This package has been deprecated

    Author message:

    This module has moved and is now available at @hapi/catbox-memory. Please update your dependencies as this version is no longer maintained an may contain bugs and security issues.

    catbox-memory
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/catbox-memory package

    4.0.1 • Public • Published

    catbox-memory

    Memory adapter for catbox. This adapter is not designed to share a common cache between multiple processes (e.g. in a cluster mode). It uses a single interval timeout to look for expired records and clean them from memory.

    Lead Maintainer - Wyatt Preul

    Current version: Current Version Build Status

    Options

    • maxByteSize - sets an upper limit on the number of bytes that can be stored in the cache. Once this limit is reached no additional items will be added to the cache until some expire. The utilized memory calculation is a rough approximation and must not be relied on. Defaults to 104857600 (100MB).
    • minCleanupIntervalMsec - the minimum number of milliseconds in between each cache cleanup. Defaults to 1 second (1000).
    • allowMixedContent - by default, all data is cached as JSON strings, and converted to an object using JSON.parse() on retrieval. By setting this option to true, Buffer data can be stored alongside the stringified data. Buffers are not stringified, and are copied before storage to prevent the value from changing while in the cache. Defaults to false.
    • cloneBuffersOnGet - by default, buffers stored in the cache with allowMixedContent set to true are copied when they are set but not when they are retrieved. This means a change to the buffer returned by a get() will change the value in the cache. To prevent this, set cloneBuffersOnGet to true to always return a copy of the cached buffer. Defaults to false.

    Install

    npm i catbox-memory

    DownloadsWeekly Downloads

    111,060

    Version

    4.0.1

    License

    BSD-3-Clause

    Unpacked Size

    10.7 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar