Giter VIP home page Giter VIP logo

simple-localstorage's Introduction

Simple LocalStorage

Creating a new localstorage db

To create a new localstorage db:

let store = new SLS('myStore');

If you do not pass in a 'name' parameter, the store will be assigned a unique ID.

Creating a new record in the store

To create a new record:

store.createOne({name:"John Smith", age:40});

Pass a JSON object to the createOne method in the store.

To find all records in the store

store.findAll();

The findAll method will return a list of all records in the store

Finding a record by query

store.findByQuery({name:"John Smith}, true);

The findByQuery takes 2 parameters. The first parameter is the query object, the second parameter is a boolean which toggles 'strict' search of the store.

When strict is true, all keys/values in the query object must match a record in the store in order for it to be returned. When strict is false, it will return all records which have at least 1 matching key/value in the query object.

Finding a record by ID

store.findById('prp12avqy2bksspccygejy29s8');

The findById method takes a record ID as a parameter, this ID is used to retrieve a record from the store.

Deleting a record by ID

store.deleteById('prp12avqy2bksspccygejy29s8');

Deleting a record by query

store.deleteByQuery({name:"John Smith}, true);

The deleteByQuery takes 2 parameters. The first parameter is the query object, the second parameter is a boolean which toggles 'strict' search of the store.

When strict is true, all keys/values in the query object must match a record in the store in order for it to be deleted. When strict is false, it will delete all records which have at least 1 matching key/value in the query object.

Updating an existing record

store.updateOneById('prp12avqy2bksspccygejy29s8', {name:"John Robert Smith"});

The updateOneById method takes 2 parameters. The ID of the record to update and an object used to update the record.

simple-localstorage's People

Contributors

crsrusl avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.