bun-sqlite-cache

Bun SQLite Cache

Bun SQLite cache is a Bun-ified version of jkelin's sqlite-lru-cache (with TTL). Bun's lightning-fast implementation makes this perfect for a quick in-memory caching solution with TTL support.

Installation

bun add bun-sqlite-cache

Usage

Using this cache is dead simple: simply create a new BunSQLiteCache instance and you're set

import { BunSQLiteCache } from "bun-sqlite-cache";

const cache = new BunSQLiteCache();

cache.set("foo", { bar: "baz", waldo: [4, 3, 2, 8] });
const value = cache.get("foo");

console.log(value) // { bar: "baz", waldo: [4, 3, 2, 8] }

Methods

Initialize

import { BunSQLiteCache, BunSQLiteCacheConfiguration } from "bun-sqlite-cache";

// the given values are the defaults
const options: BunSQLiteCacheConfiguration = {
    database: ":memory:", // database file or in memory: default :- in memory sqlite table
    defaultTtlMs: undefined, // the default time it takes (in ms) for a cached row to expire: default :- no expiry
    maxItems: undefined, // max number of items allowed in cache. if number of items is exceeded then LRU eviction policy is used: default :- no limit
    compress: false // whether to compress data before putting it in the cache (uses Bun's synchronous gzip)
}

const cache = new BunSQLiteCache(options)

set(key: string, value: any, opts?: { ttlMs?: number, compress?: boolean }): boolean

Adds a value to the cache by serializing the given value and adding it to the table

• key: the key to store the value under
• value: the value to store - can be anything serializable by 'v8'
• opts:
  • ttlMs: the time it takes (in ms) for a cached row to expire: default:- no expiry
  • compress: whether to compress data before putting it in the cache (uses Bun's synchronous gzip)
• returns: boolean dictating whether the value was successfully added to the cache

get(key: string, withMeta?: boolean): any | ValueWithMeta<T> | undefined

Gets a value from the cache by deserializing the value stored under the given key

• key: the key to get the value from
• withMeta: whether to return the value with its metadata (i.e. compressed and key): default:- false
  • if withMeta is true, the return value will be of type ValueWithMeta<T>: { value: any, compressed: boolean, key: string }
• returns: Deserialized value stored under the given key (any)

delete(key: string): void

Deletes a value from the cache

• key: the key to delete the value from
• returns: void

clear(): void

Clears the cache

• returns: void

Contributing

Contributions are welcome - this is my first package so it's probably riddled with stuff that could be improved. Feel free to open an issue or submit a pull request.

License

MIT