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

vanilla-db

v0.3.0

Published

lightweight browser database library thats built on top of localStorage and sessionStorage.

Downloads

21

Readme

VanillaDb

VanillaDb is a lightweight browser database library thats built on top of localStorage and sessionStorage.

Installation

  npm install --save vanilla-db@latest

Once the package is installed, you can import the library using import vanillaDb

import { vanillaDb } from 'vanilla-db'

Documentation

Storing Data

to store data using vanillaDb

const config = {
  db: 'local', // or 'session', 'localStorage', 'sessionStorage',
  key: 'my-database-key' ,
  data: {
    name: 'John Doe',
    age: 40,
    role: 'React Developer'
  }
}

vanillaDb.set(config)

to Get stored data, call the set() method and pass an object with key: Database key, db: which can either be "local || localStorage" or "session || sessionStorage" , data: the data you are storing (which can be arrays, object, or just a variable or state).

Getting Data

VanillaDb uses key-value pair method in storing datas, you will be able to get the stored data by referencing its database key.

const query = {
  db: 'local', // or 'session', 'localStorage', 'sessionStorage',
  key: 'my-database-key',
  option: 'all' || 'only'
}

vanillaDb.get(query)

to Get stored data, call the get() method and pass an object with db: the database data is stored key: database key. option: to either return all the Database or only the data stored.

Sync Data

sync(copy) allow you to copy or move data within sessionStorage and localStorage,

const config = {
  from: 'local', 
  to: 'session',
  key: 'my-data' ,
  options: {
      deleteOld: true // or false,
      newKey: 'my-synced-data'
  }
}

vanillaDb.sync(config)

to use sync(copy) create an object with

from: the database you can are copying/syncing data from, to: the new database you are copying/syncing to key: the key of the database you want to copy/sync.

options contains deleteOld: which can either be true or false to delete old stored data newKey: for the new data synced.

More Features

  • remove(db) - remove the data stored in Database
  • length(db) - return the length of data stored in Database
  • request(db) - fetch data from api (mostly get) and store the data in database for offline usage.

Usage/Examples

const query = {
  db: 'local' // 'session',
  key: 'your database key',
}

vanillaDb.remove(query)

query contains the database you stored your data and the key of the database you want to remove.

const db =  'local' // 'session',

vanillaDb.length(db)

db is the Database you stored data or the Database you which to know its length.

import { vanillaDb } from 'vanilla-db'

const config =  {
    url: 'api endpoint',
    db: 'local' // 'session',
    key: 'database key',
    options: {'fetch request options'}
}

vanillaDb.request(config)

db is the Database you stored data.

NPM

JavaScript Style Guide

Contact

License

MIT ©