GM.setValue: Difference between revisions
simplify |
|||
| Line 14: | Line 14: | ||
== Syntax == | == Syntax == | ||
{{Function|GM_setValue|name, value}} | |||
Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]] | |||
== Arguments == | |||
; <code>name</code> | |||
: <code>String</code> The unique (within this script) name for this value. Should be restricted to valid Javascript identifier characters. | |||
; <code>value</code> | |||
: | : <code>String</code>, <code>Integer</code> or <code>Boolean</code> Any valid value of these types. Any other type may cause undefined behavior, including crashes. | ||
: | |||
== Returns == | |||
==== | |||
<code>undefined</code> | |||
== Examples == | |||
<pre class='sample'> | <pre class='sample'> | ||
GM_setValue("foo", "bar"); | GM_setValue("foo", "bar"); | ||
| Line 51: | Line 36: | ||
== See Also == | == See Also == | ||
* [[GM_getValue]] | * [[GM_getValue]] | ||
* [[GM_deleteValue]] | * [[GM_deleteValue]] | ||
* [[GM_listValues]] | * [[GM_listValues]] | ||
* [[:Category:Coding Tips:Persistence]] | |||
== Notes == | == Notes == | ||
<sup>[[GM_setValue#top|[1]]]</sup> Please see [http://groups.google.com/group/greasemonkey-users/t/ca5a0dfac5c5998b this mailing list thread] for details. | <sup>[[GM_setValue#top|[1]]]</sup> Please see [http://groups.google.com/group/greasemonkey-users/t/ca5a0dfac5c5998b this mailing list thread] for details. | ||
[[Category:API_Reference|S]] | [[Category:API_Reference|S]] | ||
Revision as of 21:15, 8 February 2010
Description
This method allows user script authors to persist simple values.
Strings, booleans, and integers are currently the only allowed data types.
Values are saved in the Firefox preferences back end and can be manually inspected or changed by typing about:config in the address bar and searching for the preference name "greasemonkey.scriptvals.namespace/name.value_name".
(For appropriate values of namespace, name and value_name.)
The Firefox preference store is not designed for storing large amounts of data. There are no hard limits, but very large amounts of data may cause Firefox to consume more memory and/or run more slowly. [1]
Syntax
function GM_setValue( name, value )
Compatibility: Greasemonkey 0.3b+
Arguments
nameStringThe unique (within this script) name for this value. Should be restricted to valid Javascript identifier characters.valueString,IntegerorBooleanAny valid value of these types. Any other type may cause undefined behavior, including crashes.
Returns
undefined
Examples
GM_setValue("foo", "bar");
See Also
Notes
[1] Please see this mailing list thread for details.
