Difference between revisions of "Bot Playground/Built-in Functions/localStorage.on"

Revision as of 11:37, 14 August 2024

Adds the event callback on localStorage. Also check localStorage.set().

localStorage.on(eventName, callback);

This command accepts the following parameters:

Variable		Required	Description
Input:
	eventName	yes	the name of the event. Currently only supported event is "update"
	callback	yes	the callback function to fire on event, function(entry, script) where entry - is the name of the key set script - the name of the script which did the change

Use this function if you want to know when other scripts do localStorage.set().

Important: the "update" event does not react on localStorage.set() calls in current script.

To see how localStorage.on("update") works you'll need two scripts:

The "Listener" script:

localStorage.on("update", function(entry, script) {
	console.log("localStorage got updated:", entry, "by script", script);

	exit();
});

The "Initiator" script:

localStorage.set("data", "data from 1");
exit();

How to run:

@@ Line 11: / Line 11: @@
 {{API Variable Group|Input}}
 {{API Variable|eventName|yes}} the name of the event. Currently only supported event is ''"update"''
-{{API Variable|callback|yes}} the callback function to fire on event, '''function(entry, value, script)''' where
+{{API Variable|callback|yes}} the callback function to fire on event, '''function(entry, script)''' where
 * entry - is the name of the key set
-* value - the value
 * script - the name of the script which did the change
@@ Line 30: / Line 29: @@
 The "Listener" script:
 <syntaxhighlight lang="javascript">
-localStorage.on("update", function(entry, value, script) {
+localStorage.on("update", function(entry, script) {
-	console.log("localStorage got updated:", entry, "=", value, "by script", script);
+	console.log("localStorage got updated:", entry, "by script", script);
 	exit();