storage.js

Storage.js

A thin wrapper around localStorage for easier access.

It uses JSON (native only, provide your own replacement if necessary) for data serialization.

You can use it with Ender, in which case it's available under $.storage instead of the Storage global. Install using ender add storage.js.

Namespaceing

Data is stored with key-value pairs. All keys can be namespaced using ns() which sets a prefix to keys. By default that prefix is empty.

• string Storage.ns(): Returns the current prefix.
• string Storage.ns(string prefix): Sets a new prefix and returns the old one.

Singular methods

Singular methods act on one key-value pair at a time.

• void Storage.set(string key, mixed data): Serializes data and stores it.
• mixed Storage.get(string key): Retrieves data and unserializes it.
• mixed Storage.def(string key, mixed default): Retrieves data if it exists, otherwise sets and returns default.
• void Storage.del(string key): Deletes the data.

Multi methods

Multi methods act on several key-value pairs at a time.

• void Storage.all.set(object {key: data, ...})
• object Storage.all.get(array [key, ...])
• object Storage.all.def(object {key: data, ...})
• void Storage.all.del(array [key, ...])