GM.getValue

From GreaseSpot Wiki
Revision as of 08:54, 30 September 2008 by Marti (talk | contribs) (reversion: Proper syntax for API needs to be maintained thruout... did include Gingerhendrix's explanation... Tobu should have read the talk page 1st referenced by bullet 1)
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 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. If default is omitted JavaScript undefined is returned.
Note: Using this property does not call GM_setValue and is is by design.

top | back

Examples

alert(GM_getValue("foo"));

top

See Also

top

Notes

top