🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

bun-sqlite-cache

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

bun-sqlite-cache

Bun SQLite cache is a Bun-ified version of [jkelin](https://github.com/jkelin)'s [sqlite-lru-cache](https://github.com/jkelin/cache-sqlite-lru-ttl) (with TTL). Bun's lightning-fast implementation makes this perfect for a quick in-memory caching solution w

1.2.0
latest
Source
npm
Version published
Weekly downloads
49
11.36%
Maintainers
1
Weekly downloads
 
Created
Source

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

Keywords

bun

FAQs

Package last updated on 26 Jan 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts