url-search-query-builder - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "url-search-query-builder",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A shortcut that allows get/set/has/delete/reset/add operation on an url that contains query or search, good for pagination and filter as well as search engine optimization",
@@ -5,0 +5,0 @@ "private": false,

README.md

@@ -73,2 +73,13 @@ # url-search-query-builder
 
+## toString()
+
+It returns the full path(Might or might not contain query);
+
+```
+const path = '/something';
+const query = { category: 'TV' };
+const builder = new QueryBuilder(path, query);
+builder.toString(); // '/something?category=TV&';
+```
+
 ## Has, get, set, delete, reset.
@@ -95,2 +106,30 @@
 
+## get
+
+Get query by name.
+
+```
+const path = '/something';
+const query = { type: 'website', page: 1 };  '/something?type=website&page=1'
+const builder = new QueryBuilder(path, query);
+builder.get('type'); // website.
+builder.get('product'); // undefined.
+```
+
+## getAll
+
+It gets all the queries;
+
+```
+const path = '/something';
+const query = { type: 'website', page: 1 };  '/something?type=website&page=1'
+const builder = new QueryBuilder(path, query);
+
+// If true is passed, it returns a string instead of object.
+
+builder.getAll(); // { type: 'website', page: 1 }
+builder.getAll(true); 'type=website&page=1';
+
+```
+
 ## Test
@@ -97,0 +136,0 @@

No alert changes

Improved metrics

Total package byte prevSize

13941

increased by6.57%

Number of lines in readme file

167

increased by30.47%

No dependency changes