url-search-params-polyfill - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

 /**
- * Created by jerry on 16/9/2.
+ *
+ *
+ * @author Jerry Bendy <[e-mail]>
+ * @licence MIT
+ *
  */
@@ -4,0 +8,0 @@

package.json

 {
   "name": "url-search-params-polyfill",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "a simple polyfill for javascript URLSearchParams",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/jerrybendy/url-search-params-polyfill",

README.md

@@ -1,2 +0,95 @@
-# url-search-params-polyfill
+# URLSearchParams polyfill
 
+This is a simple polyfill library for javascript's URLSearchParams class.
+
+
+## Installation
+
+This can also be installed with `npm`.
+
+```sh
+$ npm install url-search-params-polyfill --save
+```
+
+
+For babel and es2015+, make sure to import the file:
+
+```javascript
+import 'url-search-params-polyfill';
+```
+
+## Usage
+
+Use `URLSearchParams` directly. You can `new` an object from a string or an object.
+
+```javascript
+// new a empty object
+var search1 = new URLSearchParams ();
+
+// from a string
+var search2 = new URLSearchParams ("id=1&from=home");
+
+// from an object
+var search3 = new URLSearchParams ({id: 1, from: "home"});
+
+// from location.search, will remove first "?" automatically
+var search4 = new URLSearchParams (window.location.search);
+
+```
+
+
+### append
+
+```javascript
+var search = new URLSearchParams ();
+
+search.append("id", 1);
+```
+
+### delete
+
+```javascript
+search.delete("id");
+```
+
+### get
+
+```javascript
+search.get("id");
+```
+
+### getAll
+
+```javascript
+search.getAll("id");
+```
+
+### has
+
+```javascript
+search.has("id");
+```
+
+### set 
+
+```javascript
+search.set("id", 2);
+```
+
+### toString
+
+```javascript
+search.toString();
+```
+
+### forEach
+
+```javascript
+search.forEach(function (item) {
+  console.log(item);
+});
+```
+
+## LICENSE
+
+MIT license

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of package files

16

increased by23.08%

Lines of code

109

increased by3.81%

Number of lines in readme file

96

increased by3100%

Worsened metrics

Total package byte prevSize

27081

decreased by-1.9%

No dependency changes