GM.info: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
Add category. |
Added space and line (horizontal rule) to increase clarity/comprehension. |
||
| Line 23: | Line 23: | ||
; version | ; version | ||
: The version of Greasemonkey, a string e.g. <tt>0.9.16</tt>. | : The version of Greasemonkey, a string e.g. <tt>0.9.16</tt>. | ||
<br /> | |||
---- | |||
The script object contains structured fields from the [[Metadata Block]]: | The '''''script''''' object contains structured fields from the [[Metadata Block]]: | ||
; description | ; description | ||
| Line 44: | Line 46: | ||
; version | ; version | ||
: Possibly empty string. | : Possibly empty string. | ||
[[Category:API_Reference|I]] | [[Category:API_Reference|I]] | ||
Revision as of 05:32, 11 February 2012
Description
An object that exposes various information about Greasemonkey and the running User Script.
Compatibility: Greasemonkey 0.9.16+
Syntax
GM_info
Returns
This object has the following properties:
- script
- An object containing data about the currently running script. See more detail below.
- scriptMetaStr
- A string, the entire literal Metadata Block (without the delimiters) for the currently running script.
- scriptWillUpdate
- A boolean; when true Greasemonkey will attempt to auto-update the script.
- version
- The version of Greasemonkey, a string e.g. 0.9.16.
The script object contains structured fields from the Metadata Block:
- description
- Possibly empty string.
- excludes
- Possibly empty array of strings.
- includes
- Possibly empty array of strings.
- matches
- Possibly empty array of strings. (Bug in 0.9.16.)
- name
- String.
- namespace
- Possibly empty string.
- run-at
- String.
- unwrap
- Boolean.
- version
- Possibly empty string.
