Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/notskamr/bun-sqlite-cache
Source code for a Bun SQLite based key-value cache
https://github.com/notskamr/bun-sqlite-cache
bun cache kv-store lru sqlite ttl
Last synced: about 1 month ago
JSON representation
Source code for a Bun SQLite based key-value cache
- Host: GitHub
- URL: https://github.com/notskamr/bun-sqlite-cache
- Owner: notskamr
- License: mit
- Created: 2024-01-12T18:46:24.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-17T08:29:49.000Z (3 months ago)
- Last Synced: 2024-07-23T12:36:36.038Z (2 months ago)
- Topics: bun, cache, kv-store, lru, sqlite, ttl
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/bun-sqlite-cache
- Size: 33.2 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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 with TTL support.
## Installation
```bash
bun add bun-sqlite-cache
```
## Usage
Using this cache is dead simple: simply create a new BunSQLiteCache instance and you're set
```typescript
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
```typescript
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 | 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`: `{ 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