Git Product home page Git Product logo

nativescript-localstorage's Introduction

npm npm npm

nativescript-localstorage

A NativeScript plugin to add LocalStorage and SessionStorage If you are trying to use any libraries that use the localStorage/sessionStorage API; or you want a fairly simple storage engine; here it is.

License

This is released under the MIT License, meaning you are free to include this in any type of program -- However for entities that need a support contract, changes, enhancements and/or a commercial license please contact me at http://nativescript.tools.

I also do contract work; so if you have a module you want built for NativeScript (or any other software projects) feel free to contact me [email protected].

Donate Patreon

Sample Snapshot

Sample1

Compatibility

Supports NativeScript 2.x and 3.x

Installation

tns plugin add nativescript-localstorage

Usage

To use the module you just require() it:

require( "nativescript-localstorage" );

localStorage.setItem('Another Plugin', 'By Master Technology');

This will enable the localStorage api. So then you can use it just like a browser.

You can also optionally do:

let LS = require( "nativescript-localstorage" );
LS.getItem('Another Plugin');  // Returns: "By Master Technology"

You ask, how exactly does this help?

This allows you to use localStorage or sessionStorage as if it is built into NativeScript.

API

localStorage.getItem(name) - Get a value from Storage

name - the key to get

This will return whatever you stored in that key, or null if that key doesn't exist.

let me = localStorage.getItem('MeaningOfLife') || 42;

localStorage.setItem(name, value) - Set a value into storage

name - the key to set
value - the value to set; this can be number, string, object, array. (Must be a native JavaScript object)
localStorage.setItem('Zork', 'You are about to be eaten by a Grue!');

localStorage.removeItem(name) - Delete and item from storage

name - the key to delete
localStorage.removeItem('Zork');  // Guess you were eaten and removed!  :-)

localStorage.clear() - clear all storage

localStorage.clear();

localStorage.length - Number of items stored

Returns the number of keys stored

console.log("Keys stored", localStorage.length);

localStorage.key(id) - Return the key name at this position

id - 0 based id of the key
returns: string name of the key (or null if id is past size of saved storage )
console.log("Key at 0 is", localStorage.key(0));

sessionStorage

You can use sessionStorage instead of localStorage for any of the routines above; the difference between the two API's is localStorage saves and will always be present, where sessionStorage is temporary, when you close the program it is gone.

Contributors

nativescript-localstorage's People

Contributors

nathanaela avatar danielkucal avatar intractablequery avatar

Watchers

 avatar David Stump avatar James Cloos 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.