feat: add support for custom request types

README.md

@@ -141,6 +141,8 @@ Injects a fake request into an HTTP server.
 
 - `dispatchFunc` - listener function. The same as you would pass to `Http.createServer` when making a node HTTP server. Has the signature `function (req, res)` where:
     - `req` - a simulated request object. Inherits from `Stream.Readable`.
+      Optionally inherits from another class, managed by
+      `options.customRequestType`
     - `res` - a simulated response object. Inherits from node's `Http.ServerResponse`.
 - `options` - request options object where:
   - `url` | `path` - a string specifying the request URL.
@@ -162,6 +164,8 @@ Injects a fake request into an HTTP server.
   - `server` - Optional http server. It is used for binding the `dispatchFunc`.
   - `autoStart` - Automatically start the request as soon as the method
     is called. It is only valid when not passing a callback. Defaults to `true`.
+  - `customRequestType` - Optional type from which the `request` object should
+    inherit besides `stream.Readable`
 - `callback` - the callback function using the signature `function (err, res)` where:
   - `err` - error object
   - `res` - a response object where:

lib/request.js

@@ -50,6 +50,7 @@ class MockSocket extends EventEmitter {
  * @param {Object} [options.cookies]
  * @param {Object} [options.headers]
  * @param {Object} [options.query]
+ * @param {Object} [options.customRequestType]
  * @param {any} [options.payload]
  */
 function Request (options) {
@@ -121,6 +122,10 @@ function Request (options) {
     simulate: options.simulate || {}
   }
 
+  if (options.customRequestType) {
+    util.inherits(this.constructor, options.customRequestType)
+  }
+
   return this
 }
 

test/test.js

@@ -99,6 +99,19 @@ test('request has rawHeaders', (t) => {
   })
 })
 
+test('request has custom type', (t) => {
+  t.plan(2)
+  const dispatch = function (req, res) {
+    t.ok(req instanceof http.IncomingMessage)
+    res.writeHead(200)
+    res.end()
+  }
+
+  inject(dispatch, { method: 'GET', url: 'http://example.com:8080/hello', customRequestType: http.IncomingMessage }, (err, res) => {
+    t.error(err)
+  })
+})
+
 test('passes remote address', (t) => {
   t.plan(2)
   const dispatch = function (req, res) {