View source for GM.info

== Description ==

An object that exposes various information about Greasemonkey and the running User Script.

Compatibility: [[Version_history#0.9.16|Greasemonkey 0.9.16+]]

== Syntax ==

<pre class='sample'>GM.info</pre>

== Returns ==

This object has the following properties:

<!-- Not (yet?) in 4.x
; isPrivate
: A boolean, true when the current window is in private mode.  (Also available as property <code>isIncognito</code>.)  Compatibility: [[Version_history#3.8|Greasemonkey 3.8+]]
-->
; 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.
<!-- not yet in 4.x
; scriptWillUpdate
: A boolean; when true Greasemonkey will attempt to auto-update the script.
-->
; scriptHandler
: The name of the user script engine handling this script's execution.  The string <code>Greasemonkey</code>.
; version
: The version of Greasemonkey, a string e.g. <tt>4.0</tt>.

----

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.
; name
: String.
; namespace
: Possibly empty string.
; resources
: An object keyed by resource name.  Each value is an object with keys <code>name</code> and <code>mimetype</code> and <code>url</code> with string values.
; run-at
: String.
; uuid
: String. Compatibility: [[Version_history#4.0|Greasemonkey 4.0+]]
; version
: Possibly empty string.

[[Category:API_Reference|I]]