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 🙏

© 2021 – Pkg Stats / Ryan Hefner

seco-keyval

v0.7.0

Published

Secure key-value store based on secure-container

Downloads

1,723

Readme

seco-keyval

Travis branch npm code style: standard

Secure key-value store built on secure-container.

Installation

npm install seco-keyval

Example

import SecoKeyval from 'seco-keyval'

const kv = new SecoKeyval('db.seco', { appName: 'exodus', appVersion: '1.0.0' })
await kv.open('1-very-secure-password', { a: 1 })

await kv.set('key', 'myValue')

const value1 = kv.get('a')
console.log(value1) // -> 1

const value2 = kv.get('key')
console.log(value2) // -> 'myValue'

API

new SecoKeyval(file, header)

  • file (String) Filename
  • header (Object)
    • appName (String) App Name
    • appVersion (String) App Version

kv.open(passphrase[, initialData])

Loads the key-value store. Creates it if it doesn't exist.

  • passphrase (String | Buffer)
  • initialData (any JSON-serializable data) Will be written if the store doesn't exist.

Returns a Promise resolving when the filesystem operations are complete. You cannot call set() or get() until this is done.

kv.set(key, value)

Sets key to value. Returns a promise resolving when the data has been written to disk.

kv.get(key)

Gets key and returns the value of key. Returns undefined if the key is not set.

kv.delete(key)

Deletes key. Returns a promise resolving when the data has been written to disk.

kv.batch(operations)

Accepts an Array of operations where each item is an Object, with the structure:

  • type The String "set" or "delete"
  • key Key to perform the operation on
  • value for set operation, the value to be set to key

Returns a promise resolving when the data has been written to disk.

kv.changePassphrase(newPassphrase)

Changes the passphrase to newPassphrase. Returns a promise resolving when the data has been written to disk.

kv.changePassphraseOnNextWrite(newPassphrase)

Schedule for the passphrase to change to newPassphrase on the next file write. There is no guarantee that the passphrase will get changed when using this method (i.e. if set() is never called afterwards). Returns undefined.

kv.getAllData()

Returns an object containing all the key-value pairs in the kv.

kv.setAllData(data)

DANGER: Don't use this method unless you know what you're doing!

This completely replaces and overwrites the key-value store with data and writes the data to disk, with no backups of the old data.

License

MIT