form-urlencoded - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "form-urlencoded",
-  "version": "0.1.0",
+  "version": "0.1.01",
   "author": "Chris <[e-mail]>",
@@ -5,0 +5,0 @@ "contributors": [{

README.md

@@ -30,54 +30,43 @@ form-urlencoded
 
- * **npm**
+**npm**
 
- ```bash
- $ npm install form-urlencoded
- ```
+```bash
+$ npm install form-urlencoded
+```
 
- * **Direct Download**
- 
- ```bash
- $ git clone https://github.com/iambumblehead/form-urlencoded.git
- ```
+to run tests, use `npm test` from a shell.
 
----------------------------------------------------------
-#### <a id="test"></a>TEST:
+```bash
+$ npm test
+```
 
- to run tests, use `npm test` from a shell.
-
- ```bash
- $ npm test
- ```
-
 ---------------------------------------------------------
-#### <a id="get-started">GET STARTED:
+#### <a id="encode">encode:
 
-**Object encoding**
-
 ```javascript
 var formurlencoded = require('form-urlencoded');
-var result = formurlencoded.encode({
+var obj = {
   propStr1 : 'str1',
   propStr2 : 'str2',
-  propObj1 : { 
-    objPropStr1 : 'objStr1', 
-    objPropStr2 : 'objStr2'
+  propStr3 : 'str2',
+  propArr : [3, { prop : 'val' }, 1, null, 6],
+  propObj : { 
+    objPropStr1 : 'objStr1',
+    objPropStr2 : null
   }
-});
-console.log(result);
-//propStr1=str1&propStr2=str2&propObj1%5BobjPropStr1%5D=objStr1&propObj1%5BobjPropStr2%5D=objStr2
-```
+};
 
-an options parameter may be passed to the encode function
-```javascript
-var result = formurlencoded.encode({
-  propStr1 : null,
-  propStr2 : 'str2',
-  propStr3 : [null, 5, 1, 6]
-}, {
+// propStr1=str1&propStr2=str2&propStr3=str2&propArr%5B%5D=
+// 3&propArr%5B%5D%5Bprop%5D=val&propArr%5B%5D=1&propArr%5B
+// %5D=null&propArr%5B%5D=6&propObj%5BobjPropStr1%5D=objStr
+// 1&propObj%5BobjPropStr2%5D=null
+
+console.log(formurlencoded.encode(obj, {
   ignorenull : true,
   sorted : true
-});
-console.log(result);
-//propStr2=str2&propStr3%5B%5D=5&propStr3%5B%5D=1&propStr3%5B%5D=6
+}));
+
+// propArr%5B%5D=3&propArr%5B%5D%5Bprop%5D=val&propArr%5B%5
+// D=1&propArr%5B%5D=6&propObj%5BobjPropStr1%5D=objStr1&pro
+// pStr1=str1&propStr2=str2&propStr3=str2
 ```
@@ -84,0 +73,0 @@

test/form-urlencoded.spec.js

@@ -144,2 +144,31 @@ var formurlencoded = require('../form-urlencoded'),
 
+  it("should return the correct test result", function () {
+    var formurlencoded = require('../form-urlencoded');
+    var obj = {
+      propStr1 : 'str1',
+      propStr2 : 'str2',
+      propStr3 : 'str2',
+      propArr : [3, { prop : 'val' }, 1, null, 6],
+      propObj : { 
+        objPropStr1 : 'objStr1',
+        objPropStr2 : null
+      }
+    };
+
+    // propStr1=str1&propStr2=str2&propStr3=str2&propArr%5B%5D=
+    // 3&propArr%5B%5D%5Bprop%5D=val&propArr%5B%5D=1&propArr%5B
+    // %5D=null&propArr%5B%5D=6&propObj%5BobjPropStr1%5D=objStr
+    // 1&propObj%5BobjPropStr2%5D=null
+
+    console.log(formurlencoded.encode(obj, {
+      ignorenull : true,
+      sorted : true
+    }));
+
+    // propArr%5B%5D=3&propArr%5B%5D%5Bprop%5D=val&propArr%5B%5
+    // D=1&propArr%5B%5D=6&propObj%5BobjPropStr1%5D=objStr1&pro
+    // pStr1=str1&propStr2=str2&propStr3=str2    
+
+    expect(true).toBe(true);
+  });
 });

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

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

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

Total package byte prevSize

14348

increased by5.35%

Lines of code

221

increased by12.76%

Worsened metrics

Number of lines in readme file

88

decreased by-11.11%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes