Getting Started

The code is contained in one JavaScript file, designed against Christian Heilmann’s Revealing Module pattern. It returns an Immediately Invoked Function Expression (IIFE) to create a local scope for all methods and variables in order to avoid polluting the global scope.

To use localDataStorage--

1. bring the code into your page (via <script> tags, direct copy, etc.)
2. instantiate it with a meaningful prefix (which provides namespacing)

The generic call would look something like localDataStorage( prefix, switch ).

For example:

<script
    src="https://cdn.jsdelivr.net/gh/macmcmeans/localDataStorage@1.3.1/localDataStorage-1.3.1.min.js"
    integrity="sha384-Rc8gyCOHcneAsNwEsjnQQLQ6JSS0ZBgZxwr2Qh7z4Knfd5O5GLnD5sm6WSCYKv+2"
    crossorigin="anonymous"
></script>

<script>
    const lds = localDataStorage( 'passphrase.life' );
</script>

At this point all key names will have the prefix passphrase.life. prepended to them (note the trailing period), so calling set( 'authorName', 'Mac' ) will store the authorName key as passphrase.life.authorName internally with a value of Mac.

To control how localDataStorage starts up, you may use a few switches. You should specify a prefix to prevent storage contamination.