GM.setValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m Text replace - "[[Metadata_block" to "[[Metadata Block" |
|||
| Line 3: | Line 3: | ||
== Description == | == Description == | ||
This | This method allows user script authors to persist simple values. | ||
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 [http://developer.mozilla.org/en/docs/Code_snippets:Preferences Firefox preferences] back end and can be manually 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]]. | Values are saved in the [http://developer.mozilla.org/en/docs/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>". | ||
(For appropriate values of <code>namespace</code>, <code>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. | |||
<sup>[[#Notes|[1]]]</sup> | |||
== Syntax == | == Syntax == | ||
Revision as of 21:05, 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
GM_setValue( name, value )
- Value: Function
- Returns: undefined[2]
- Compatibility: Greasemonkey 0.3b+
Properties
name
- Value: String
- Usage:
name = "PropertyName";
- Property name to retrieve or create.
value
- Value: String, Integer or Boolean
- Usage:
value = 5;
Examples
GM_setValue("foo", "bar");
See Also
Notes
[1] Please see this mailing list thread for details.
