Initial Commit

Author: kcak11

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.

README.md

@@ -0,0 +1,54 @@
+# <b>js-queryparams</b>
+
+### A JavaScript library to retrieve the query parameters with cross browser compatibility.
+
+---
+
+## 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 direct reference to the `lib/index.js` file or extract it and host it in your webserver.
+
+---
+
+## Usage:
+<br/>  Assume the current browser url is:  
+https://www.example.com/?abc=123&xyz=somevalue&abc=45  
+<br/>
+### The library has the following functions:
+<br/>
+<b>Get a specific query parameter:</b>
+
+```
+queryParams.get(<paramName>);
+
+e.g.:
+queryParams.get("abc"); --> ["123", "45"] i.e. an Array of values
+queryParams.get("xyz"); --> "somevalue" i.e. a single value
+```
+
+<br/>
+<b>Get all the query parameters:</b>
+
+```
+queryParams.getAll() --> {abc: Array(2), xyz: Array(1)}
+```
+
+<br/>
+<b>Change the reference "queryParams":</b>
+
+```
+queryParams.changeRef(<newRefName>);
+
+e.g.:
+queryParams.changeRef("$qp");
+console.log(queryParams); --> ReferenceError
+$qp.get("abc"); --> ["123", "45"]
+```
+Once the reference is changed, the old reference is deleted so trying to use it will result in a ReferenceError.
+
+---
+
+## License: MIT (https://mit-license.kcak11.com)

lib/index.js

@@ -0,0 +1,89 @@
+/**
+ * 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 () {
+            paramsMap
+            var params = window.location.search && window.location.search.substr(1);
+            if (params) {
+                var paramsList = params.split("&");
+                for (var i = 0; i < paramsList.length; i++) {
+                    var keyValue = paramsList[i].split("=");
+                    paramsMap = paramsMap || {};
+                    paramsMap[keyValue[0]] = paramsMap[keyValue[0]] || [];
+                    paramsMap[keyValue[0]].push(keyValue[1]);
+                }
+            }
+        };
+
+        /**
+         * 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) {
+            if (paramsMap && paramsMap[paramName]) {
+                if (paramsMap[paramName].length === 1) {
+                    return JSON.parse(JSON.stringify(paramsMap[paramName][0]));
+                } else {
+                    return JSON.parse(JSON.stringify(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 () {
+            return JSON.parse(JSON.stringify(paramsMap));
+        };
+
+        /**
+         * 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();
+    })()));
+})());

package.json

@@ -0,0 +1,22 @@
+{
+  "name": "js-queryparams",
+  "version": "1.0.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"
+  }
+}