Remote Cache

A front-end module for automating the caching of server-side requests

Usage

The resolver property must be specified with an asynchronous function that accepts a single key value and eventually returns a value from an (optionally) remote provider. It could be used for long calculations as well.

The data between acquiring the request for the key and the eventual return of the value can be modified freely and any type of data may be returned.

Import using CommonJS or ESM modules

const { RemoteCache } = require('remote-cache')

import RemoteCache from 'remote-cache'

Create a cache and configure it

const cache = new RemoteCache({
    resolver: async (key) => {
        return await (await fetch(`example.com/api/items/${key}`)).text()
    },
    expiry: null,
    capacity: null,
})

// ...

let item = await cache.get('keyname')
cache.set('keyname', 8)

List of Methods

• get(key) - Get the value from the cache or download with the resolver
• set(key, value, ttl?) - Set the local key manually
• reload(key) - Resolve the key with the resolver and store it in the cache
• reloadAll(keys?) - Resolve the keys with the resolver and store them in the cache
• invalidate(key) - Invalidate a key in the cache by removing it
• reset() - Invalidate all keys in the cache
• size() - Get the number of cached items
• clean() - Remove invalid and expired items from the cache