@stash-it/sqlite-adapter

@stash-it/sqlite-adapter is a Sqlite3 adapter that can be used with @stash-it/stash-it.

Installation

npm

npm install @stash-it/sqlite-adapter

deno

deno add @stash-it/sqlite-adapter

yarn

yarn dlx jsr add @stash-it/sqlite-adapter

pnpm

pnpm dlx jsr add @stash-it/sqlite-adapter

bun

bunx jsr add @stash-it/sqlite-adapter

Usage

// Import stash-it main class.
import { StashIt } from '@stash-it/stash-it';
import { SqliteAdapter } from '@stash-it/sqlite-adapter';

// Create an instance of the adapter.
const adapter = new SqliteAdapter({ dbPath: 'path/to/your/db.sqlite' });

// And use it with stash-it.
const stash = new StashIt(adapter);

Configuration

const adapterOptions: SqliteAdapterOptions = {
    dbPath: 'path/to/your/db.sqlite', // <-- this is the only required configuration
    // rest of them are optional; the default values, if not passed, are the values below:
    tableName: 'items',
    keyColumnName: 'key',
    valueColumnName: 'value',
    extraColumnName: 'extra'
};

License

MIT

Contribution

Feel free to open an issue or a pull request.