GM.getValue

From GreaseSpot Wiki
Revision as of 22:38, 2 January 2008 by Gingerhendrix (talk | contribs)
Jump to navigationJump to search

Template:Underscore


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

Examples | See Also

Syntax

GM_getValue( name, default )

Value: Function
Returns: String, Integer, Boolean or undefined
Compatibility: Greasemonkey 0.3b+
Parameters
Properties
name
default
  • All properties are optional except name.

top

Properties


name

Value: String
Usage: name = "PropertyName";
  • Property name to retrieve.

top | back

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.

top | back

Examples

alert(GM_getValue("foo"));

top

See Also

top