snipt

Ctrl+h for KB shortcuts

JavaScript

Parsing, encoding and updating URL params in JavaScript

// compatible with "use strict"

function decodeURIParams(query) {
  if (query == null)
    query = window.location.search;
  if (query[0] == '?')
    query = query.substring(1);

  var params = query.split('&');
  var result = {};
  for (var i = 0; i < params.length; i++) {
    var param = params[i];
    var pos = param.indexOf('=');
    if (pos >= 0) {
        var key = decodeURIComponent(param.substring(0, pos));
        var val = decodeURIComponent(param.substring(pos + 1));
        result[key] = val;
    } else {
        var key = decodeURIComponent(param);
        result[key] = true;
    }
  }
  return result;
}

function encodeURIParams(params, addQuestionMark) {
  var pairs = [];
  for (var key in params) if (params.hasOwnProperty(key)) {
    var value = params[key];
    if (value != null) /* matches null and undefined */ {
      pairs.push(encodeURIComponent(key) + '=' + encodeURIComponent(value))
    }
  }
  if (pairs.length == 0)
    return '';
  return (addQuestionMark ? '?' : '') + pairs.join('&');
}

//// alternative to $.extend if not using jQuery:
// function mergeObjects(destination, source) {
//   for (var key in source) if (source.hasOwnProperty(key)) {
//     destination[key] = source[key];
//   }
//   return destination;
// }

function navigateWithURIParams(newParams) {
  window.location.search = encodeURIParams($.extend(decodeURIParams(), newParams), true);
}


// example usage

// add/update parameters
navigateWithURIParams({ foo: 'bar', boz: 42 });

// remove parameter
navigateWithURIParams({ foo: null });

// submit the given form by adding/replacing URI parameters
$('.filter-form').submit(function(e) {
  e.preventDefault();
  navigateWithURIParams(decodeURIParams($(this).serialize()));
});
https://snipt.net/embed/80429919d83653a95077cafbf9e03943/
/raw/80429919d83653a95077cafbf9e03943/
80429919d83653a95077cafbf9e03943
js
JavaScript
65
2019-08-21T18:06:56
True
False
False
Feb 04, 2013 at 10:34 PM
/api/public/snipt/55186/
parsing-encoding-and-updating-url-params-in-javascript
<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#L-1"> 1</a> <a href="#L-2"> 2</a> <a href="#L-3"> 3</a> <a href="#L-4"> 4</a> <a href="#L-5"> 5</a> <a href="#L-6"> 6</a> <a href="#L-7"> 7</a> <a href="#L-8"> 8</a> <a href="#L-9"> 9</a> <a href="#L-10">10</a> <a href="#L-11">11</a> <a href="#L-12">12</a> <a href="#L-13">13</a> <a href="#L-14">14</a> <a href="#L-15">15</a> <a href="#L-16">16</a> <a href="#L-17">17</a> <a href="#L-18">18</a> <a href="#L-19">19</a> <a href="#L-20">20</a> <a href="#L-21">21</a> <a href="#L-22">22</a> <a href="#L-23">23</a> <a href="#L-24">24</a> <a href="#L-25">25</a> <a href="#L-26">26</a> <a href="#L-27">27</a> <a href="#L-28">28</a> <a href="#L-29">29</a> <a href="#L-30">30</a> <a href="#L-31">31</a> <a href="#L-32">32</a> <a href="#L-33">33</a> <a href="#L-34">34</a> <a href="#L-35">35</a> <a href="#L-36">36</a> <a href="#L-37">37</a> <a href="#L-38">38</a> <a href="#L-39">39</a> <a href="#L-40">40</a> <a href="#L-41">41</a> <a href="#L-42">42</a> <a href="#L-43">43</a> <a href="#L-44">44</a> <a href="#L-45">45</a> <a href="#L-46">46</a> <a href="#L-47">47</a> <a href="#L-48">48</a> <a href="#L-49">49</a> <a href="#L-50">50</a> <a href="#L-51">51</a> <a href="#L-52">52</a> <a href="#L-53">53</a> <a href="#L-54">54</a> <a href="#L-55">55</a> <a href="#L-56">56</a> <a href="#L-57">57</a> <a href="#L-58">58</a> <a href="#L-59">59</a> <a href="#L-60">60</a> <a href="#L-61">61</a> <a href="#L-62">62</a> <a href="#L-63">63</a> <a href="#L-64">64</a></pre></div></td><td class="code"><div class="highlight"><pre><span></span><span id="L-1"><a name="L-1"></a><span class="c1">// compatible with &quot;use strict&quot;</span> </span><span id="L-2"><a name="L-2"></a> </span><span id="L-3"><a name="L-3"></a><span class="kd">function</span> <span class="nx">decodeURIParams</span><span class="p">(</span><span class="nx">query</span><span class="p">)</span> <span class="p">{</span> </span><span id="L-4"><a name="L-4"></a> <span class="k">if</span> <span class="p">(</span><span class="nx">query</span> <span class="o">==</span> <span class="kc">null</span><span class="p">)</span> </span><span id="L-5"><a name="L-5"></a> <span class="nx">query</span> <span class="o">=</span> <span class="nb">window</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">search</span><span class="p">;</span> </span><span id="L-6"><a name="L-6"></a> <span class="k">if</span> <span class="p">(</span><span class="nx">query</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;?&#39;</span><span class="p">)</span> </span><span id="L-7"><a name="L-7"></a> <span class="nx">query</span> <span class="o">=</span> <span class="nx">query</span><span class="p">.</span><span class="nx">substring</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span> </span><span id="L-8"><a name="L-8"></a> </span><span id="L-9"><a name="L-9"></a> <span class="kd">var</span> <span class="nx">params</span> <span class="o">=</span> <span class="nx">query</span><span class="p">.</span><span class="nx">split</span><span class="p">(</span><span class="s1">&#39;&amp;&#39;</span><span class="p">);</span> </span><span id="L-10"><a name="L-10"></a> <span class="kd">var</span> <span class="nx">result</span> <span class="o">=</span> <span class="p">{};</span> </span><span id="L-11"><a name="L-11"></a> <span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="nx">i</span> <span class="o">&lt;</span> <span class="nx">params</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span> <span class="nx">i</span><span class="o">++</span><span class="p">)</span> <span class="p">{</span> </span><span id="L-12"><a name="L-12"></a> <span class="kd">var</span> <span class="nx">param</span> <span class="o">=</span> <span class="nx">params</span><span class="p">[</span><span class="nx">i</span><span class="p">];</span> </span><span id="L-13"><a name="L-13"></a> <span class="kd">var</span> <span class="nx">pos</span> <span class="o">=</span> <span class="nx">param</span><span class="p">.</span><span class="nx">indexOf</span><span class="p">(</span><span class="s1">&#39;=&#39;</span><span class="p">);</span> </span><span id="L-14"><a name="L-14"></a> <span class="k">if</span> <span class="p">(</span><span class="nx">pos</span> <span class="o">&gt;=</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span> </span><span id="L-15"><a name="L-15"></a> <span class="kd">var</span> <span class="nx">key</span> <span class="o">=</span> <span class="nb">decodeURIComponent</span><span class="p">(</span><span class="nx">param</span><span class="p">.</span><span class="nx">substring</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nx">pos</span><span class="p">));</span> </span><span id="L-16"><a name="L-16"></a> <span class="kd">var</span> <span class="nx">val</span> <span class="o">=</span> <span class="nb">decodeURIComponent</span><span class="p">(</span><span class="nx">param</span><span class="p">.</span><span class="nx">substring</span><span class="p">(</span><span class="nx">pos</span> <span class="o">+</span> <span class="mi">1</span><span class="p">));</span> </span><span id="L-17"><a name="L-17"></a> <span class="nx">result</span><span class="p">[</span><span class="nx">key</span><span class="p">]</span> <span class="o">=</span> <span class="nx">val</span><span class="p">;</span> </span><span id="L-18"><a name="L-18"></a> <span class="p">}</span> <span class="k">else</span> <span class="p">{</span> </span><span id="L-19"><a name="L-19"></a> <span class="kd">var</span> <span class="nx">key</span> <span class="o">=</span> <span class="nb">decodeURIComponent</span><span class="p">(</span><span class="nx">param</span><span class="p">);</span> </span><span id="L-20"><a name="L-20"></a> <span class="nx">result</span><span class="p">[</span><span class="nx">key</span><span class="p">]</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span> </span><span id="L-21"><a name="L-21"></a> <span class="p">}</span> </span><span id="L-22"><a name="L-22"></a> <span class="p">}</span> </span><span id="L-23"><a name="L-23"></a> <span class="k">return</span> <span class="nx">result</span><span class="p">;</span> </span><span id="L-24"><a name="L-24"></a><span class="p">}</span> </span><span id="L-25"><a name="L-25"></a> </span><span id="L-26"><a name="L-26"></a><span class="kd">function</span> <span class="nx">encodeURIParams</span><span class="p">(</span><span class="nx">params</span><span class="p">,</span> <span class="nx">addQuestionMark</span><span class="p">)</span> <span class="p">{</span> </span><span id="L-27"><a name="L-27"></a> <span class="kd">var</span> <span class="nx">pairs</span> <span class="o">=</span> <span class="p">[];</span> </span><span id="L-28"><a name="L-28"></a> <span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">key</span> <span class="k">in</span> <span class="nx">params</span><span class="p">)</span> <span class="k">if</span> <span class="p">(</span><span class="nx">params</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="nx">key</span><span class="p">))</span> <span class="p">{</span> </span><span id="L-29"><a name="L-29"></a> <span class="kd">var</span> <span class="nx">value</span> <span class="o">=</span> <span class="nx">params</span><span class="p">[</span><span class="nx">key</span><span class="p">];</span> </span><span id="L-30"><a name="L-30"></a> <span class="k">if</span> <span class="p">(</span><span class="nx">value</span> <span class="o">!=</span> <span class="kc">null</span><span class="p">)</span> <span class="cm">/* matches null and undefined */</span> <span class="p">{</span> </span><span id="L-31"><a name="L-31"></a> <span class="nx">pairs</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nb">encodeURIComponent</span><span class="p">(</span><span class="nx">key</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39;=&#39;</span> <span class="o">+</span> <span class="nb">encodeURIComponent</span><span class="p">(</span><span class="nx">value</span><span class="p">))</span> </span><span id="L-32"><a name="L-32"></a> <span class="p">}</span> </span><span id="L-33"><a name="L-33"></a> <span class="p">}</span> </span><span id="L-34"><a name="L-34"></a> <span class="k">if</span> <span class="p">(</span><span class="nx">pairs</span><span class="p">.</span><span class="nx">length</span> <span class="o">==</span> <span class="mi">0</span><span class="p">)</span> </span><span id="L-35"><a name="L-35"></a> <span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="p">;</span> </span><span id="L-36"><a name="L-36"></a> <span class="k">return</span> <span class="p">(</span><span class="nx">addQuestionMark</span> <span class="o">?</span> <span class="s1">&#39;?&#39;</span> <span class="o">:</span> <span class="s1">&#39;&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="nx">pairs</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s1">&#39;&amp;&#39;</span><span class="p">);</span> </span><span id="L-37"><a name="L-37"></a><span class="p">}</span> </span><span id="L-38"><a name="L-38"></a> </span><span id="L-39"><a name="L-39"></a><span class="c1">//// alternative to $.extend if not using jQuery:</span> </span><span id="L-40"><a name="L-40"></a><span class="c1">// function mergeObjects(destination, source) {</span> </span><span id="L-41"><a name="L-41"></a><span class="c1">// for (var key in source) if (source.hasOwnProperty(key)) {</span> </span><span id="L-42"><a name="L-42"></a><span class="c1">// destination[key] = source[key];</span> </span><span id="L-43"><a name="L-43"></a><span class="c1">// }</span> </span><span id="L-44"><a name="L-44"></a><span class="c1">// return destination;</span> </span><span id="L-45"><a name="L-45"></a><span class="c1">// }</span> </span><span id="L-46"><a name="L-46"></a> </span><span id="L-47"><a name="L-47"></a><span class="kd">function</span> <span class="nx">navigateWithURIParams</span><span class="p">(</span><span class="nx">newParams</span><span class="p">)</span> <span class="p">{</span> </span><span id="L-48"><a name="L-48"></a> <span class="nb">window</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">search</span> <span class="o">=</span> <span class="nx">encodeURIParams</span><span class="p">(</span><span class="nx">$</span><span class="p">.</span><span class="nx">extend</span><span class="p">(</span><span class="nx">decodeURIParams</span><span class="p">(),</span> <span class="nx">newParams</span><span class="p">),</span> <span class="kc">true</span><span class="p">);</span> </span><span id="L-49"><a name="L-49"></a><span class="p">}</span> </span><span id="L-50"><a name="L-50"></a> </span><span id="L-51"><a name="L-51"></a> </span><span id="L-52"><a name="L-52"></a><span class="c1">// example usage</span> </span><span id="L-53"><a name="L-53"></a> </span><span id="L-54"><a name="L-54"></a><span class="c1">// add/update parameters</span> </span><span id="L-55"><a name="L-55"></a><span class="nx">navigateWithURIParams</span><span class="p">({</span> <span class="nx">foo</span><span class="o">:</span> <span class="s1">&#39;bar&#39;</span><span class="p">,</span> <span class="nx">boz</span><span class="o">:</span> <span class="mi">42</span> <span class="p">});</span> </span><span id="L-56"><a name="L-56"></a> </span><span id="L-57"><a name="L-57"></a><span class="c1">// remove parameter</span> </span><span id="L-58"><a name="L-58"></a><span class="nx">navigateWithURIParams</span><span class="p">({</span> <span class="nx">foo</span><span class="o">:</span> <span class="kc">null</span> <span class="p">});</span> </span><span id="L-59"><a name="L-59"></a> </span><span id="L-60"><a name="L-60"></a><span class="c1">// submit the given form by adding/replacing URI parameters</span> </span><span id="L-61"><a name="L-61"></a><span class="nx">$</span><span class="p">(</span><span class="s1">&#39;.filter-form&#39;</span><span class="p">).</span><span class="nx">submit</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span> </span><span id="L-62"><a name="L-62"></a> <span class="nx">e</span><span class="p">.</span><span class="nx">preventDefault</span><span class="p">();</span> </span><span id="L-63"><a name="L-63"></a> <span class="nx">navigateWithURIParams</span><span class="p">(</span><span class="nx">decodeURIParams</span><span class="p">(</span><span class="nx">$</span><span class="p">(</span><span class="k">this</span><span class="p">).</span><span class="nx">serialize</span><span class="p">()));</span> </span><span id="L-64"><a name="L-64"></a><span class="p">});</span> </span></pre></div> </td></tr></table>
dom, javascript