Release 3.5.0

K.C.Ashish Kumar · K.C.Ashish Kumar · commit ffa63896498a · 2021-06-07T13:39:28.000+05:30
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 NPX Binaries
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,77 @@
+# <b>js-queryparams</b>
+
+### <i>A JavaScript library to retrieve the query parameters with cross-browser support.</i>
+
+---
+<br/>
+
+## How to Install:
+Inside your project, run the following command:
+```
+npm i js-queryparams
+```
+The above command will install the js-queryparams module inside the node_modules folder. After this you can either directly refer to the `node_modules/js-queryparams/lib/index.js` file from within your webpage or extract it and host it in your webserver.
+
+---
+<br/>
+
+## Usage:  
+Assume the current browser url is:  
+```
+https://www.example.com/?p1=v1&p2=some=text&p3={"key1":"val1","key2":[1,2,3,4]}&p4=v4&p4=a4&p4=&p5=https://www.example.com&p6=https%3A%2F%2Fwww.example.com%2F%3Fabc%3Ddef%26pqr%3Dxyz&p7=test=01&p8&p9=v9#somehash
+```
+<br/>
+### The library has the following functions:
+<br/>
+<b>Get a specific query parameter:</b>
+
+```
+queryParams.get(<paramName>);
+
+e.g.:
+queryParams.get("p1"); // --> "v1" i.e. a single value.
+queryParams.get("p4"); // --> ["v4", "a4", ""] i.e. an Array of values, if the parameter gets repeated in the query string.
+```
+
+<br/>
+<b>Get all the query parameters:</b>
+
+```
+queryParams.getAll() 
+
+// Output: 
+
+{
+    "p1": "v1",
+    "p2": "some=text",
+    "p3": "{\"key1\":\"val1\",\"key2\":[1,2,3,4]}",
+    "p4": [
+        "v4",
+        "a4",
+        ""
+    ],
+    "p5": "https://www.example.com",
+    "p6": "https://www.example.com/?abc=def&pqr=xyz",
+    "p7": "test=01",
+    "p8": "",
+    "p9": "v9"
+}
+```
+
+<br/>
+<b>Change the reference "queryParams":</b>
+
+```
+queryParams.changeRef(<newRefName>);
+
+e.g.:
+queryParams.changeRef("$qp");
+console.log(queryParams); --> ReferenceError
+$qp.get("p1"); --> ["v1"]
+```
+Once the reference is changed, the old reference is deleted, so trying to use it will result in a ReferenceError.
+
+---
+<br/>
+
+## License: MIT (https://mit-license.kcak11.com)
diff --git a/lib/index.js b/lib/index.js
@@ -0,0 +1,108 @@
+/**
+ * js-queryparams
+ *
+ * Author: K.C.Ashish Kumar
+ * License: MIT
+ */
+
+/**
+ * This library facilitates retrieval of the query parameters across all the browsers.
+ */
+
+(function () {
+    var refName = "queryParams";
+    typeof window !== "undefined" &&
+        (window[refName] = (function () {
+            var paramsMap;
+
+            /**
+             * constructor: QueryParams
+             * constructs the base map for the query parameters
+             */
+            var QueryParams = function () { };
+
+            var buildParamsMap = function () {
+                paramsMap = null;
+                var params = window.location.search && window.location.search.substr(1);
+                if (params) {
+                    var paramsList = params.split("&");
+                    for (var i = 0; i < paramsList.length; i++) {
+                        try {
+                            var keyValue = paramsList[i].split("=");
+                            var key = decodeURIComponent(keyValue[0]);
+                            var value = decodeURIComponent(keyValue.slice(1).join("="));
+                            paramsMap = paramsMap || {};
+                            paramsMap[key] = paramsMap[key] || [];
+                            paramsMap[key].push(value);
+                        } catch (exjs) {
+                            console.log("Error parsing entry:", paramsList[i]);
+                        }
+                    }
+                }
+            };
+
+            var valueParser = function (obj) {
+                return JSON.stringify(obj, function (k, v) {
+                    if (v instanceof Array) {
+                        if (v.length === 1) {
+                            return v[0];
+                        }
+                        return v;
+                    }
+                    return v;
+                });
+            };
+
+            /**
+             * Retrieves a specific query parameter.
+             * If the parameter is a single value, the value is returned else an Array is returned.
+             *
+             * The returned value is Immutable i.e. updating the returned values does not affect the actual params in any way.
+             * @param paramName
+             */
+            QueryParams.prototype.get = function (paramName) {
+                buildParamsMap();
+                if (paramsMap && paramsMap[paramName]) {
+                    return JSON.parse(valueParser(paramsMap[paramName]));
+                }
+                return null;
+            };
+
+            /**
+             * Retrieve all the parameters.
+             *
+             * The returned value is Immutable i.e. updating the returned values does not affect the actual params in any way.
+             */
+            QueryParams.prototype.getAll = function () {
+                buildParamsMap();
+                return JSON.parse(valueParser(paramsMap || null));
+            };
+
+            /**
+             * Use a different name for referencing instead of the default "queryParams".
+             * After this call i.e. queryParams.changeRef("xyz"), the new reference will be "xyz" i.e.
+             * All the subsequent calls should be made using xyz e.g.:
+             * xyz.get("...")
+             * xyz.getAll()
+             *
+             * @param name
+             */
+            QueryParams.prototype.changeRef = function (name) {
+                if (!window[name]) {
+                    window[name] = window[refName];
+                    delete window[refName];
+                    refName = name;
+                } else {
+                    throw new Error(name + " is already used in window");
+                }
+            };
+
+            /**
+             * Globally exposed singleton instance.
+             *
+             * use via "queryParams" in the window object.
+             * To change the reference, use the queryParams.changeRef("...") function
+             */
+            return new QueryParams();
+        })());
+})();
diff --git a/package.json b/package.json
@@ -0,0 +1,22 @@
+{
+  "name": "js-queryparams",
+  "version": "3.5.0",
+  "description": "A JavaScript library to retrieve the query parameters with cross browser compatibility.",
+  "main": "index.js",
+  "keywords": [
+    "queryparams",
+    "queryparameters",
+    "js-queryparams",
+    "query",
+    "params",
+    "parameters",
+    "query parameters",
+    "query params"
+  ],
+  "author": "K.C.Ashish Kumar",
+  "license": "MIT",
+  "repository": {
+    "url": "https://github.com/npx-bin/js-queryparams.git",
+    "type": "GIT"
+  }
+}
