vanillish
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

vanillish

What is it?

tl;dr: easy-to-use in-browser CRUD db

A brand new package project! It's a CRUD wrapper around @brightsole/vanillite.

It has a number of methods that make setting, getting, querying, and deleting data a dream!

It's ready for you to add some functionality, and publish it!


How to use it?

tl;dr: npm i vanillish
methodName args return
setItem StorageItem Promise(StorageItemWithId)
getItem id Promise(StorageItemWithId)
getAll none Promse([StorageItemWithId])
deleteItem id Promise(none)
deleteAll none Promise(none)
query QueryObject Promise([StorageItemWithId])

TODO:

tl;dr: alot; but it's functional

High priority

  1. type the query object
  2. test it
    1. create
    2. read
    3. update
    4. delete
    5. very thoroughly test querying, especially deep comparisons like 'dingle.bloop.floobo': ['niner']
  3. UNBREAK THE STORAGE LIB - we stopped allowing a variable storage lib to screw down the types and get the dep working. I'd like that unbroken so that you could instantiate it with localforage to remove the caching, or vanillite to optimise speed with an in-memory cache

Low priority

  1. refactor methods to only be CRUD, no named createAll, just look at inputs for what to do
  2. allow for querying using regex queryParam properties ✨

Buy Me A Coffee

Readme

Keywords

Package Sidebar

Install

npm i vanillish

Weekly Downloads

3

Version

1.0.0

License

MIT

Unpacked Size

7.62 kB

Total Files

4

Last publish

Collaborators

  • one19