Expanded documentation for parseGETParameters

This commit is contained in:
Erik Thuning 2023-08-16 09:18:14 +02:00
parent 1b29fadaa0
commit df2dab7adc

@ -125,6 +125,13 @@
* Parse the GET parameters in the URL bar into an Object, mapping keys
* to values. Will not behave properly on repeated keys.
*
* Recognizes two nested levels of key-value pairs:
* key1=value1&key2=value2 (standard GET syntax)
* nestedKey1:nestedValue1;nestedKey2:nestedValue2 (custom extension)
*
* This would be a full query string with a nested key-value mapping:
* key1=nestedkey1:nestedvalue1;nestedkey2:nestedvalue2&key2=value2
*
* The Object has a toString() method which returns the parameters in the
* same format as `window.location.search`.
*/