zachcurtis/managed-misses-cache

Memory cache with bound miss functions to allow for cleaner data layer abstraction

managed-misses-cache

Memory cache with bound miss functions to allow for cleaner data layer abstraction

Installation

npm install managed-misses-cache

Example

import Cache from 'managed-misses-cache'
async () => {
    await Cache.bindMissHandler('name', 15000, async function(){
        return 'sam'
    })

    let name = await Cache.get('name')
}

Usage

Generic Miss Handlers

The key missed is passed to the miss handler allowing you to better generalize their logic.

async function getData(key: string): Promise<string> {

    switch (key) {
        case 'name':
            return 'sam'

        case 'job':
            return 'driver'
    }
}

await Cache.bindMissHandler('name', 15000, getData)
await Cache.bindMissHandler('job', 15000, getData)

setTimeout(async function(){
    let name = await Cache.get('name')
    let job = await Cache.get('job')

    console.log(name) // sam
    console.log(job) // driver
}, 200)

Manually Force Miss

let _name = 'sam'
await Cache.bindMissHandler('name', 15000, async function(){
    return _name
})

let name1 = await Cache.get('name') // sam

_name = 'john'
await Cache.miss('name')

let name2 = await Cache.get('name') // john

Filter With getConcat

async function getData(key: string): Promise<Array<any>> {

    switch (key) {
        case 'spots':
            return ['ledge gap', 'Bank']

        case 'stairs':
            return ['5 stair' , '12 stair']
    }
    return ['']
}

await Cache.bindMissHandler('spots', 15000, getData)
await Cache.bindMissHandler('stairs', 15000, getData)

setTimeout(async function() {
    let allSpots = await Cache.getConcat(['spots', 'stairs'])
    // ['ledge gap', 'Bank', '5 stair', '12 stair']
}, 500)

Cache Sections

import { SectionedCache } from 'managed-misses-cache'

await SectionedCache.bindMissHandler('users', 'user-1329', 15000, () => {
    
})

managed-misses-cache's Issues

A public method to force a miss is needed.

The module should allow for manual missing of the cache to reload data at that key.