https://github.com/global-source/javascript_uri_query
Core Javascript Library for URL Operations.
https://github.com/global-source/javascript_uri_query
Last synced: 5 months ago
JSON representation
Core Javascript Library for URL Operations.
- Host: GitHub
- URL: https://github.com/global-source/javascript_uri_query
- Owner: global-source
- License: mit
- Created: 2017-01-28T04:26:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-07-24T11:18:54.000Z (almost 6 years ago)
- Last Synced: 2025-05-05T02:38:04.794Z (about 1 year ago)
- Language: JavaScript
- Size: 71.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Javascript URI Query
Core Javascript Library for Powerful URL level Operations ADD|UPDATE|DELETE and much more...
[](https://github.com/global-source/javascript_uri_query/releases/tag/v.2)
[](https://github.com/global-source/javascript_uri_query)
___
One library to perform most of the **URI** operations.
Such as,
Action | Method | Description |
-------------|-----------------------------------|-------------|
Add | URI.addNew(key, val) | To add new param to URL. |
Bulk Add | URI.add([{key1 : val1},{key2: val2}])| To add multiple params to URL.|
Append | URI.append(key, val) | To add new item to the existing value. |
Update Value | URI.add([{key: val}]) | To perform update with add function. |
Delete | URI.remove(key) | To remove param from URL. |
Bulk Delete | URI.remove([key1, key2]) | To remove multiple param from URL. |
Delete All | URI.removeAll() | To remove all param in the URL. |
Clear | URI.clear() | TO clear the URL history. |
Update | URI.update() | To update URI status. |
Get | URI.get(key) | To get value of a param. |
## Installation
Include the URI library to project by using,
```html
```
For **ES6**:
```html
let URI = new _URI();
```
## Methods
### getAll()
To get list of URI params as Object.
```javascript
URI.getAll();
// URL : http://domain.com/?type=my-ticket&page=1&limit=5
// Output : ["type=myTicket", "page=1", "limit=5"]
```
### get()
To get value of the param from URI.
```javascript
URI.get('type');
// URI : http://domain.com/?type=myTicket&page=2&limit=5
// OUT : 'myTicket'
```
### addNew()
To add single param to the URI. If item already exists, then value get updated.
```javascript
URI.add('page', 1);
// Before URL : http://domain.com/?type=my-ticket
// After URL : http://domain.com/?type=my-ticket&page=1
```
### add()
To add list of params to the URI. If item already exists, then value get updated.
```javascript
URI.add([{'page': 1}, {'limit': 5}]);
// Before URL : http://domain.com/?type=my-ticket
// After URL : http://domain.com/?type=my-ticket&page=1&limit=5
```
### append()
To append value to the param in the URI.
```javascript
URI.append(name, bala);
// Before URL : http://domain.com/?name=shankar
// After URL : http://domain.com/?name=shankar,bala
```
### remove()
To remove list of param from the URI.
```javascript
URI.remove(['page','limit']); // For Bulk.
URI.remove('type'); // For Single.
URI.remove('id','55') // For Single Value.
// Before URL : http://domain.com/?type=my-ticket&page=1&limit=5
// After URL : http://domain.com/?
// For Single Value:
// Before URL : http://domain.com/?id=45,23,55,34
// After URL : http://domain.com/?id=45,23,34
```
### removeAll()
To remove all param in the URI.
```javascript
URI.removeAll();
// Before URI : http://domain.com/?type=my-ticket&page=2&limit=5
// After URI : http://domain.com/?
```
### prevPage()
To go back to previous page by update the URI.
```javascript
URI.prevPage();
// Before URL : http://domain.com/?type=my-ticket&page=2&limit=5
// After URL : http://domain.com/?type=my-ticket&page=1&limit=5
```
### nextPage()
To move to next page by update the URI.
```javascript
URI.nextPage();
// Before URL : http://domain.com/?type=my-ticket&page=1&limit=5
// After URL : http://domain.com/?type=my-ticket&page=2&limit=5
```
### isParamExists()
To check the param is exist in URI or Not.
```javascript
URI.isParamExists('page');
URI.isParamExists('newPage');
// URL : http://domain.com/?type=my-ticket&page=2&limit=5
// OUT 1 : true
// OUT 2 : false
```
# License
MIT License