docs: easy form (#88)

Author: Eomm

README.md

@@ -72,21 +72,22 @@ try {
 }
 ```
 
-File uploads (multipart/form-data) can be achieved by using [form-data](https://github.com/form-data/form-data) package as shown below:
+File uploads (`multipart/form-data`) or form submit (`x-www-form-urlencoded`) can be achieved by using [form-auto-content](https://github.com/Eomm/form-auto-content) package as shown below:
 
 ```js
-const FormData = require('form-data')
+const formAutoContent = require('form-auto-content')
 const fs = require('fs')
 
 try {
-  const form = new FormData()
-  form.append('myfile', fs.createReadStream(`./path/to/file`))
+  const form = formAutoContent({
+    myField: 'hello',
+    myFile: fs.createReadStream(`./path/to/file`)
+  })
 
   const res = await inject(dispatch, {
     method: 'post',
     url: '/upload',
-    payload: form,
-    headers: form.getHeaders()
+    ...form
   })
   console.log(res.payload)
 } catch (err) {

package.json

@@ -12,6 +12,7 @@
   "types": "index.d.ts",
   "devDependencies": {
     "@types/node": "^13.1.0",
+    "form-auto-content": "^1.0.0",
     "form-data": "^3.0.0",
     "pre-commit": "^1.2.2",
     "standard": "^14.0.2",

test/test.js

@@ -12,6 +12,7 @@ const inject = require('../index')
 const parseURL = require('../lib/parseURL')
 
 const FormData = require('form-data')
+const formAutoContent = require('form-auto-content')
 
 const httpMethods = [
   'delete',
@@ -1477,3 +1478,33 @@ test('errors for invalid undefined header value', (t) => {
     t.ok(err)
   }
 })
+
+test('example with form-auto-content', (t) => {
+  t.plan(4)
+  const dispatch = function (req, res) {
+    let body = ''
+    req.on('data', d => {
+      body += d
+    })
+    req.on('end', () => {
+      res.end(body)
+    })
+  }
+
+  const form = formAutoContent({
+    myField: 'my value',
+    myFile: fs.createReadStream('./LICENSE')
+  })
+
+  inject(dispatch, {
+    method: 'POST',
+    url: 'http://example.com:8080/hello',
+    payload: form.payload,
+    headers: form.headers
+  }, (err, res) => {
+    t.error(err)
+    t.equal(res.statusCode, 200)
+    t.ok(/--.+\r\nContent-Disposition: form-data; name="myField"\r\n\r\nmy value\r\n--.*/.test(res.payload))
+    t.ok(/--.+\r\nContent-Disposition: form-data; name="myFile"; filename="LICENSE"\r\n.*/.test(res.payload))
+  })
+})