Difference between revisions of "Bot Playground/Built-in Functions/localStorage.on"
From SmartBots Developers Docs
| (2 intermediate revisions by the same user not shown) | |||
| Line 11: | Line 11: | ||
{{API Variable Group|Input}} | {{API Variable Group|Input}} | ||
{{API Variable|eventName|yes}} the name of the event. Currently only supported event is ''"update"'' | {{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, script)''' where | + | {{API Variable|callback|yes}} the callback function to fire on event, '''function(entry, value, script)''' where |
* entry - is the name of the key set | * entry - is the name of the key set | ||
| + | * value - the value | ||
* script - the name of the script which did the change | * script - the name of the script which did the change | ||
{{API Variables Table End}} | {{API Variables Table End}} | ||
| + | |||
| + | |||
| + | == Limitations == | ||
| + | |||
| + | See [[Bot_Playground/Built-in_Functions/localStorage.set|localStorage.set()]] for storage limitations. | ||
== Comments == | == Comments == | ||
| Line 29: | Line 35: | ||
The "Listener" script: | The "Listener" script: | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
| − | localStorage.on("update", function(entry, script) { | + | localStorage.on("update", function(entry, value, script) { |
| − | console.log("localStorage got updated:", entry, "by script", script); | + | console.log("localStorage got updated:", entry, "=", value, "by script", script); |
exit(); | exit(); | ||
| Line 49: | Line 55: | ||
{{NavMenu}} | {{NavMenu}} | ||
| + | __NOTOC__ | ||
Latest revision as of 12:38, 14 August 2024
Adds the event callback on localStorage. Also check localStorage.set().
localStorage.on(eventName, callback);
Reference
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, value, script) where
| |
Limitations
See localStorage.set() for storage limitations.
Comments
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.
Example
To see how localStorage.on("update") works you'll need two scripts:
The "Listener" script:
localStorage.on("update", function(entry, value, script) {
console.log("localStorage got updated:", entry, "=", value, "by script", script);
exit();
});
The "Initiator" script:
localStorage.set("data", "data from 1");
exit();
How to run:
- Launch the "Listener" script (it will keep running)
- Launch the "Initiator" script (it will run and stop)
- Now switch to the "Listener" script and check the runtime logs of "Listener"
