GM setValue

From GreaseSpot

Jump to: navigation, search
The correct title of this article is GM_setValue. The substitution or omission of an _ is due to technical restrictions.


[edit] Description

This API method allows user script authors to persist simple values locally.

Strings, booleans, and integers are currently the only allowed data types. 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.

The Firefox preference store is not designed for storing large amounts of data. There are no hard limits, but very large amounts of data may cause Firefox to consume more memory and/or run more slowly.[1]

Examples | See Also | Notes

[edit] Syntax

GM_setValue( name, value )

Value: Function
Returns: Nothing[2]
Compatibility: Greasemonkey 0.3b+
Parameters
Properties
name
value
  • All properties are optional except name and value.

top

[edit] Properties


[edit] name

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

top | back

[edit] value

Value: String, Integer or Boolean
Usage: value = 5;

top | back

[edit] Examples

GM_setValue("foo", "bar");

top

[edit] See Also

top

[edit] Notes

[1] Please see this mailing list thread for details.

top

Personal tools