Difference between revisions of "GM.setValue"

From GreaseSpot Wiki
Jump to navigationJump to search
m (Text replace - "top " to "")
m (Text replace - "top | back'' " to "")
Line 38: Line 38:
:* Property name to retrieve or create.
:* Property name to retrieve or create.


[[#top|top]] | [[#Syntax|back]]''


==== <code>value</code> ====
==== <code>value</code> ====

Revision as of 16:45, 3 February 2010


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.scriptvals.namespace/name.foo".

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

Syntax

GM_setValue( name, value )

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

Properties


name

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


value

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

top | back

Examples

Template:Samp

See Also

Notes

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