Difference between revisions of "Bot Playground/Built-in Functions/localStorage.set"
| Line 16: | Line 16: | ||
{{API Variables Table End}} | {{API Variables Table End}} | ||
| + | |||
| + | == Limitations == | ||
| + | |||
| + | localStorage is intended to store short key-value pairs. The size of the value is limited to 6144 bytes. If you exceed this size script generates a warning: | ||
| + | |||
| + | localStorage value is more than 6144 bytes and not persistent | ||
== Comments == | == Comments == | ||
Latest revision as of 13:24, 14 August 2024
Puts a string value into a persistent storage. Also check localStorage.get().
localStorage.set(name, value);
Reference
This command accepts the following parameters:
| Variable | Required | Description
| |
|---|---|---|---|
| Input: | |||
| name | yes | the name of the persistent value you would like to store | |
| value | yes | the value you want to save. | |
| Output: | |||
| result | This function does not return anything | ||
Limitations
localStorage is intended to store short key-value pairs. The size of the value is limited to 6144 bytes. If you exceed this size script generates a warning:
localStorage value is more than 6144 bytes and not persistent
Comments
This function works similar to browser JavaScript localStorage.set(). It saves value into a persistent storage.
localStorage is shared by all scripts of the same bot. Thus, you can set values in one bot script and retrieve it in another script.
Also note that localStorage supports string values only. To save something more complicated, use JSON.stringify(var).
Inter-script communication
Executing localStorage.set() will cause localStorage.on("update") event to fire on other scripts of this bot.
