GM.getValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m (Inclusive changes with discussion) |
m (→Syntax: Including both possibilities for now... Thanks Gingerhendrix :)) |
||
| Line 15: | Line 15: | ||
:Value: Function | :Value: Function | ||
:Returns: String, Integer, Boolean | :Returns: String, Integer, Boolean, undefined and null<sup>[[Talk:GM_getValue|[1]]]</sup> | ||
:Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]] | :Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]] | ||
Revision as of 05:59, 7 January 2008
Description
This API method retrieves a value that is set with GM_setValue.
Values are saved in the Firefox preferences back end and can be manually changed by typing about:config in the address bar and searching for the preference name "greasemonkey.scriptval.script-namespace/script-name".
Syntax
GM_getValue( name, default )
- Value: Function
- Returns: String, Integer, Boolean, undefined and null[1]
- Compatibility: Greasemonkey 0.3b+
- All properties are optional except name.
Properties
name
- Value: String
- Usage:
name = "PropertyName";
- Property name to retrieve.
default
- Value: String, Integer or Boolean
- Usage:
default = 5;
- If name is not found, then use this property to return a default value.
- Note: Using this property does not call GM_setValue and is by design.
Examples
alert(GM_getValue("foo"));
