XKit

XKit.storage: store and retrieve information.

:warning: Note: the user can erase an extension’s storage by clicking on Reset Settings in the XKit Control Panel.

Methods

# XKit.storage.set(extension_id, key, value)

Sets key to value. Returns true on success.

Example usage:

XKit.storage.set("my_extension", "name", "xenixlet");

# XKit.storage.get(extension_id, key, default_value)

Retrieves the value of key from storage. If nothing is found, returns default_value.

Example usage:

var my_name = XKit.storage.get("my_extension", "name", "");
if (my_name !== "") {
    alert("Your name is " + my_name);
}

# XKit.storage.get_all(extension_id)

Returns everything stored in extension_id storage area as an object.

# XKit.storage.remove(extension_id, key)

Removes key from storage. Returns true on success.

Example usage:

XKit.storage.remove("my_extension", "name");

# XKit.storage.size(extension_id)

Returns the size of data stored by extension_id.

# XKit.storage.quota(extension_id)

Returns the storage space left for extension_id.

Example usage:

if (XKit.storage.quota("my_extension") >= 300) {
    // Store a 300-character data here!
} else {
    // Clear the storage
    XKit.storage.clear("my_extension");
}

# XKit.storage.clear(extension_id)

Clear storage area for extension_id.

Tips