Neptune: Planet or Myth?

    simple-map-cache

    3.0.3 • Public • Published

    Simple Map Cache

    This module a very simple key/value storage for node, so you can cache any operation, function or call results. The cache map persist after the module is reloaded (the map is stored in a JSON file)

    This used to be part of my module simple-fetch-cache, but I decided to extract it and publish it on its own. It doesn't have any external dependencies and it uses the native Map object to track the entries.

    Install

    You can install with [npm]:

    $ npm install --save simple-map-cache

    Usage

    Please look at the index.test.js file to check how the module can be used, but in a nutshell these are the methods available:

    set, get, del, clear

    Parameter Description
    set Add new entry to the cache. ie set('day', 'friday')
    get Retrieves entry from the cache. get('day') // returns friday. undefined for the non existing values.
    del Removes entry from the cache
    clear Wipes out all the entries from the cache

    Time to live (TTL)

    All the requests cached in memory will persist there as long as the process in running. Nevertheless if you require the cache to expire after X miliseconds, you can pass it as a second parameter. ie:

    // It will disappear after 100 msec.
    > const cache = require('simple-map-cache')
    > cache.set('testephimeral', 'shouldberemovedsoon', 100)
     

    License

    Copyright © 2019, Juan Convers. Released under the MIT License.

    Keywords

    Install

    npm i simple-map-cache

    DownloadsWeekly Downloads

    24

    Version

    3.0.3

    License

    MIT

    Unpacked Size

    6.96 kB

    Total Files

    5

    Last publish

    Collaborators

    • webdacjs