Merge pull request #110 from RafaelGSS/fix-typescript-chain

Fix typescript chain response

Author: RafaelGSS

index.d.ts

@@ -86,7 +86,7 @@ declare namespace LightMyRequest {
     cookies: Array<object>
   }
 
-  interface Chain {
+  interface Chain extends Promise<Response> {
     delete: (url: string) => Chain
     get: (url: string) => Chain
     head: (url: string) => Chain
@@ -100,7 +100,8 @@ declare namespace LightMyRequest {
     payload: (payload: InjectPayload) => Chain
     query: (query: object) => Chain
     cookies: (query: object) => Chain
-    end: (callback?: CallbackFunc) => Promise<Response>
+    end(): Promise<Response>
+    end(callback: CallbackFunc): void
   }
 }
 

test/async-await.js

@@ -1,7 +1,7 @@
 'use strict'
 
 function asyncAwaitTest (t, inject) {
-  t.plan(3)
+  t.plan(4)
 
   t.test('basic async await', async t => {
     const dispatch = function (req, res) {
@@ -44,6 +44,20 @@ function asyncAwaitTest (t, inject) {
       t.fail(err)
     }
   })
+
+  t.test('chainable api with async await without end()', async t => {
+    const dispatch = function (req, res) {
+      res.writeHead(200, { 'Content-Type': 'text/plain' })
+      res.end('hello')
+    }
+
+    try {
+      const res = await inject(dispatch).get('http://example.com:8080/hello')
+      t.equal(res.payload, 'hello')
+    } catch (err) {
+      t.fail(err)
+    }
+  })
 }
 
 module.exports = asyncAwaitTest

test/index.test-d.ts

@@ -58,12 +58,20 @@ inject(dispatch, { method: 'get', url: '/', query: { name1: ['value1', 'value2']
   expectResponse(res)
 })
 
+expectType<void>(
+  inject(dispatch)
+    .get('/')
+    .end((err, res) => {
+      expectType<Error>(err)
+      expectType<Response>(res)
+      console.log(res.payload)
+    })
+)
+
 inject(dispatch)
   .get('/')
-  .end((err, res) => {
-    expectType<Error>(err)
-    expectType<Response>(res)
-    console.log(res.payload)
+  .then((value) => {
+    expectType<Response>(value)
   })
 
 expectType<Chain>(inject(dispatch))

test/test.js

@@ -9,6 +9,7 @@ const zlib = require('zlib')
 const http = require('http')
 const { finished } = require('stream')
 const eos = require('end-of-stream')
+const semver = require('semver')
 
 const inject = require('../index')
 const parseURL = require('../lib/parseURL')
@@ -845,7 +846,7 @@ test('promises support', (t) => {
 })
 
 test('async wait support', t => {
-  if (Number(process.versions.node[0]) >= 8) {
+  if (semver.gt(process.versions.node, '8.0.0')) {
     require('./async-await')(t, inject)
   } else {
     t.pass('Skip because Node version < 8')