npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@haxtra/kvstore-sqlite

v0.11.0

Published

Basic key-value store for SQLite databases

Downloads

4

Readme

kvstore-sqlite

Basic key-value store for SQLite databases.

Install

npm install @haxtra/kvstore-sqlite

Fineprint

  • requires super-sqlite3 or better-sqlite3 instance as the database driver
  • everything is passed through JSON on the way in and out, so:
    • NaN, Infinity become nulls
    • no circular references
    • if data is not JSONable, it will throw

Usage

Create instance

const KVStore = require('@haxtra/kvstore-sqlite')

const kv = new KVStore(superSqlite3Instance, {
    table: 'kvstore'  // table to use for the store, default "kvstore"
})

// when running for the first time, create the table
kv.createTable()

API

Note: All methods are synchronous.

Set/update value

kv.set(keyName, jsonableData)

Retrieve value from the store, falling back to optional default

kv.get(keyName, defaultValue?)

Remove key from the store

kv.delete(keyName)

Check if key exists, returns timestamp of the last update, or false if key is not set

kv.has(keyName)

Get count of stored keys

kv.count()

Get array of stored keys

kv.keys(page?, perPage?)

Get full store data, as an array of objects

kv.data(page?, perPage?)

Remove all data from the store

kv.purge()

Schema

Create table

Create store table with preconfigured name, defaults to kvstore. Returns true on success, false if table exists, throws on invalid table name.

kv.createTable()

Get schema

Get schema definition as a SQL string, with respect to current config.

kv.getSchema()

Schema file

Get absolute path to schema.sql file:

require.resolve('@haxtra/kvstore-sqlite/schema.sql')

License

MIT