Difference between revisions of "GM.setValue"

From GreaseSpot Wiki
Jump to navigationJump to search
m (added description to code example;)
m (clarify that it refers to the script's name)
Line 3: Line 3:
== Description ==
== Description ==


This method allows user script authors to persist simple values.
This method allows user script authors to persist simple values across page-loads.


Strings, booleans, and integers are currently the only allowed data types.  
Strings, booleans, and integers are currently the only allowed data types.  
Values are saved in the [https://developer.mozilla.org/en/Code_snippets/Preferences Firefox preferences] back end and can be manually inspected or changed by typing [[mozillazine:About:config|about:config]] in the address bar and searching for the preference name "<code>greasemonkey.scriptvals.[[Metadata Block#.40namespace|namespace]]/[[Metadata Block#.40name|name]].value_name</code>".
Values are saved in the [https://developer.mozilla.org/en/Code_snippets/Preferences Firefox preferences] back end and can be manually inspected or changed by typing [[mozillazine:About:config|about:config]] in the address bar and searching for the preference name "<code>greasemonkey.scriptvals.[[Metadata Block#.40namespace|namespace]]/[[Metadata Block#.40name|script_name]].value_name</code>".
(For appropriate values of <code>namespace</code>, <code>name</code> and <code>value_name</code>.)
(For appropriate values of <code>namespace</code>, <code>script_name</code> and <code>value_name</code>.)


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.
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.

Revision as of 20:23, 10 May 2011


Description

This method allows user script authors to persist simple values across page-loads.

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/script_name.value_name". (For appropriate values of namespace, script_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]

Compatibility: Greasemonkey 0.3b+

Syntax

function GM_setValue( name, value )

Arguments

name
String The unique (within this script) name for this value. Should be restricted to valid Javascript identifier characters.
value
String, Integer or Boolean Any valid value of these types. Any other type may cause undefined behavior, including crashes.

Returns

undefined

Examples

Set the name foo to hold the value bar:

GM_setValue("foo", "bar");

See Also

Notes

[1] Please see this mailing list thread for details.