GM.listValues: Difference between revisions

From GreaseSpot Wiki
Jump to navigationJump to search
← Older edit
Aavindraa (talk | contribs)
167 edits
→‎Examples: adding example from http://userscripts.org/topics/34069 by charmy
under to dot in API link; mention more explicitly that the strings are value _names_
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{underscore|title=GM_listValues}}
{{DISPLAYTITLE:GM_listValues}}
__NOTOC__
{{Greasemonkey Manual TOC}}


== Description ==
== Description ==


This [[API_reference|API]] method retrieves an array of preference names that start with the branch's root.
This method retrieves an array of preference names that this script has stored.
See [[GM.setValue]] for details on the storage of these values.


Values are retrieved from the [http://developer.mozilla.org/en/docs/Code_snippets:Preferences Firefox preferences] back end and can be manually viewed by typing [[mozillazine:About:config|about:config]] in the address bar and searching for the preference name "<code>greasemonkey.scriptvals.[[Metadata_block#.40namespace|namespace]]/[[Metadata_block#.40name|name]].</code>".
== Syntax ==


[[#Examples|Examples]] | [[#See_Also|See Also]] | [[#Notes|Notes]]
{{Function|GM.listValues|}}


== Syntax ==
Compatibility: [[Version_history#4.0_2|Greasemonkey 4.0+]]


'''GM_listValues()'''
=== Arguments ===


:Value: Function
None.
:Returns: String Array
:Compatibility: [[Version_history#0.8.20090123.1|Greasemonkey 0.8.1+]]


:{| cellpadding="5" style="border-style:solid; background:#FFFFE0;"
=== Returns ===
|+ Parameters
!style="background:#CC9900;"|'''Properties'''
|-
|}
:* There are currently no properties.


[[#top|top]]
A [[Promise]], rejected in case of error and otherwise resolved with an <code>Array</code> of <code>String</code>s names for previously set values.


== Examples ==
== Examples ==
{{Core samp |1=<pre style="border: none; margin: inherit;">
GM_log(GM_listValues());
</pre>}}


An array of values used by a script:
<pre class='sample'>
{{Core samp |1=<pre style="border: none; margin: inherit;">
console.log(await GM.listValues());
var vals = new Array();
</pre>
for each(var val in GM_listValues())
    vals.push(GM_getValue(val));
</pre>}}
 
Equivalent:
{{Core samp |1=<pre style="border: none; margin: inherit;">
var vals = GM_listValues().map(GM_getValue);
</pre>}}
 
[[#top|top]]


== See Also ==
== See Also ==
* [[GM_getValue]]
* [[GM_setValue]]
* [[GM_deleteValue]]
[[#top|top]]


== Notes ==
* [[GM.getValue]]
* [[GM.setValue]]
* [[GM.deleteValue]]


[[#top|top]]
[[Category:API_Reference|L]]
[[Category:API_Reference|L]]

Latest revision as of 20:49, 20 October 2022


Description

This method retrieves an array of preference names that this script has stored. See GM.setValue for details on the storage of these values.

Syntax

function GM.listValues( )

Compatibility: Greasemonkey 4.0+

Arguments

None.

Returns

A Promise, rejected in case of error and otherwise resolved with an Array of Strings names for previously set values.

Examples

console.log(await GM.listValues());

See Also

Retrieved from "https://wiki.greasespot.net/index.php?title=GM.listValues&oldid=7753"