GM.getValue

From GreaseSpot Wiki
Revision as of 20:11, 21 August 2008 by Tobu (talk | contribs) (Explain what happens without a default.)
Jump to navigationJump to search

Template:Underscore


Description

This API method retrieves a value that was set with GM_setValue. If nothing was set and a default value is passed, it returns that default. Failing that, it returns undefined.

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

Syntax

GM_getValue( name, default )

Value: Function
Returns: String, Integer, Boolean, undefined and null[1]
Compatibility: Greasemonkey 0.3b+
Parameters
Properties
name
default
  • All parameters are optional except name.

top

Parameters


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, default is returned. (With no default, 'undefined' is returned.)
Note: GM_setValue won't be called to set the value to the default, this is by design.

top | back

Examples

alert(GM_getValue("foo"));

top

See Also

top

Notes

top