Merge pull request #100 from keithamus/3.0.0

chore: build for 3.0.0

Author: keithamus

README.md

@@ -126,9 +126,7 @@ chai.request(app)
      expect(res).to.have.status(200);
   });
 ```
-
 ##### Caveat
-
 Because the `end` function is passed a callback, assertions are run
 asynchronously. Therefore, a mechanism must be used to notify the testing
 framework that the callback has completed. Otherwise, the test will pass before
@@ -218,44 +216,6 @@ agent
   })
 ```
 
-### .then (resolveCb, rejectCb)
-
-* **@param** _{Function}_ resolveCB 
-* **@cb** {Response}
-* **@param** _{Function}_ rejectCB 
-* **@cb** {Error}
-
-Invoke the request to to the server. The response
-will be passed as a parameter to the resolveCb,
-while any errors will be passed to rejectCb.
-
-```js
-chai.request(app)
-  .get('/')
-  .then(function (res) {
-    expect(res).to.have.status(200);
-  }, function (err) {
-     throw err;
-  });
-```
-
-### .catch (rejectCb)
-
-* **@param** _{Function}_ rejectCB 
-* **@cb** {Error}
-
-Invoke the request to to the server, catching any
-errors with this callback. Behaves the same as
-Promises.
-
-```js
-chai.request(app)
-  .get('/')
-  .catch(function (err) {
-    throw err;
-  });
-```
-
 ## Assertions
 
 The Chai HTTP module provides a number of assertions

dist/chai-http.js

@@ -25,7 +25,7 @@ var http = require('http')
  * construct a request to an application or url.
  *
  * Upon construction you are provided a chainable api that
- * allow to you specify the http VERB request (get, post, etc)
+ * allows you to specify the http VERB request (get, post, etc)
  * that you wish to invoke.
  *
  * #### Application / Server
@@ -61,7 +61,7 @@ var http = require('http')
  * chai.request(app)
  *   .put('/user/me')
  *   .set('X-API-Key', 'foobar')
- *   .send({ passsword: '123', confirmPassword: '123' })
+ *   .send({ password: '123', confirmPassword: '123' })
  * ```
  *
  * ```js
@@ -101,12 +101,45 @@ var http = require('http')
  * ```js
  * chai.request(app)
  *   .put('/user/me')
- *   .send({ passsword: '123', confirmPassword: '123' })
+ *   .send({ password: '123', confirmPassword: '123' })
  *   .end(function (err, res) {
  *      expect(err).to.be.null;
  *      expect(res).to.have.status(200);
  *   });
  * ```
+ * ##### Caveat
+ * Because the `end` function is passed a callback, assertions are run
+ * asynchronously. Therefore, a mechanism must be used to notify the testing
+ * framework that the callback has completed. Otherwise, the test will pass before
+ * the assertions are checked.
+ *
+ * For example, in the [Mocha test framework](http://mochajs.org/), this is
+ * accomplished using the
+ * [`done` callback](https://mochajs.org/#asynchronous-code), which signal that the
+ * callback has completed, and the assertions can be verified:
+ *
+ * ```js
+ * it('fails, as expected', function(done) { // <= Pass in done callback
+ *   chai.request('http://localhost:8080')
+ *   .get('/')
+ *   .end(function(err, res) {
+ *     expect(res).to.have.status(123);
+ *     done();                               // <= Call done to signal callback end
+ *   });
+ * }) ;
+ *
+ * it('succeeds silently!', function() {   // <= No done callback
+ *   chai.request('http://localhost:8080')
+ *   .get('/')
+ *   .end(function(err, res) {
+ *     expect(res).to.have.status(123);    // <= Test completes before this runs
+ *   });
+ * }) ;
+ * ```
+ *
+ * When `done` is passed in, Mocha will wait until the call to `done()`, or until
+ * the [timeout](http://mochajs.org/#timeouts) expires. `done` also accepts an
+ * error parameter when signaling completion.
  *
  * #### Dealing with the response - Promises
  *
@@ -116,7 +149,7 @@ var http = require('http')
  * ```js
  * chai.request(app)
  *   .put('/user/me')
- *   .send({ passsword: '123', confirmPassword: '123' })
+ *   .send({ password: '123', confirmPassword: '123' })
  *   .then(function (res) {
  *      expect(res).to.have.status(200);
  *   })

dist/chai-http.js.map

@@ -1,6 +1,6 @@
 {
   "name": "chai-http",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "Extend Chai Assertion library with tests for http apis",
   "author": "Jake Luer <jake@alogicalparadox.com>",
   "keywords": [