Add typescript defintions

Author: bilby91

.travis.yml

@@ -29,8 +29,9 @@ before_install:
   - "test ! -d node_modules || npm rebuild"
 script:
   # Run test script, depending on istanbul install
-  - "test ! -z $(npm -ps ls istanbul) || npm test"
-  - "test   -z $(npm -ps ls istanbul) || npm run-script test-travis"
-  - "test   -z $(npm -ps ls eslint  ) || npm run-script lint"
+  - "test ! -z $(npm -ps ls istanbul  ) || npm test"
+  - "test   -z $(npm -ps ls istanbul  ) || npm run-script test-travis"
+  - "test   -z $(npm -ps ls eslint    ) || npm run-script lint"
+  - "test   -z $(npm -ps ls typescript) -a -z $TRAVIS_NODE_VERSION != '0.8' || npm run-script test-typings"
 after_script:
   - "test -e ./coverage/lcov.info && npm install coveralls@2 && cat ./coverage/lcov.info | coveralls"

README.md

@@ -151,6 +151,10 @@ app.use(vhost('api.example.com', function (req, res) {
 app.listen(3000)
 ```
 
+### Typescript support
+
+Typescript defintions are included in npm package.
+
 ## License
 
 [MIT](LICENSE)

index.d.ts

@@ -0,0 +1,23 @@
+import * as http from "http"
+
+declare namespace vhost {
+  interface RequestHandler {
+    (req: http.IncomingMessage, res: http.ServerResponse, next: Function): void
+  }
+}
+
+declare function vhost(host: string, handler: vhost.RequestHandler): vhost.RequestHandler
+
+declare module "http" {
+  interface IVHost {
+    host: string,
+    hostname: string,
+    length: number
+  }
+
+  interface IncomingMessage {
+    vhost: IVHost | string[]
+  }
+}
+
+export = vhost

package.json

@@ -9,6 +9,8 @@
   "license": "MIT",
   "repository": "expressjs/vhost",
   "devDependencies": {
+    "@types/connect": "3.4.31",
+    "@types/node": "9.6.5",
     "eslint": "3.19.0",
     "eslint-config-standard": "10.2.1",
     "eslint-plugin-import": "2.8.0",
@@ -18,19 +20,23 @@
     "eslint-plugin-standard": "3.0.1",
     "istanbul": "0.4.5",
     "mocha": "2.5.3",
-    "supertest": "1.1.0"
+    "supertest": "1.1.0",
+    "typescript": "2.8.1"
   },
   "files": [
     "LICENSE",
     "HISTORY.md",
-    "index.js"
+    "index.js",
+    "index.d.ts"
   ],
+  "typings": "index.d.ts",
   "engines": {
     "node": ">= 0.8.0"
   },
   "scripts": {
     "lint": "eslint --plugin markdown --ext js,md .",
     "test": "mocha --reporter spec --bail --check-leaks test/",
+    "test-typings": "tsc -p tsconfig.json",
     "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/",
     "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/"
   }

test/test.ts

@@ -0,0 +1,19 @@
+import * as vhost from "../index"
+import * as connect from "connect"
+
+const app = connect()
+
+// Using application
+vhost("*.example.com", app)
+
+// Using request handler
+vhost("*.example.com",  (req, res, next) => {
+  if (req.vhost instanceof Array) {
+    req.vhost[0] === 'foo'
+    req.vhost[1] === 'bar'
+  } else {
+    req.vhost.host === 'foo.bar.example.com:8080'
+    req.vhost.hostname === 'foo.bar.example.com'
+    req.vhost.length === 2
+  }
+})

tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "lib": [
+      "es6"
+    ],
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "types": [
+      "node"
+    ],
+    "noEmit": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "files": [
+    "index.d.ts",
+    "test/test.ts"
+  ]
+}