GM getValue
From GreaseSpot
- The correct title of this article is GM_getValue. The substitution or omission of an _ is due to technical restrictions.
[edit] 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".
[edit] 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.
[edit] Properties
[edit] name
- Value: String
- Usage:
name = "PropertyName";
- Property name to retrieve.
[edit] 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.
[edit] Examples
alert(GM_getValue("foo"));
