Add types definition for TS integration (#55)

* Add typescript definition for plugin

* Move @types/node to devDependencies

* Add test for types

* Add typescript check to test stage

Author: mbalabash

index.d.ts

@@ -0,0 +1,18 @@
+import { Plugin } from 'fastify'
+import { Server, IncomingMessage, ServerResponse } from 'http'
+
+declare const fastifyCompress: Plugin<
+  Server,
+  IncomingMessage,
+  ServerResponse,
+  {
+    global?: boolean
+    threshold?: number
+    customTypes?: RegExp
+    brotli?: NodeModule
+    zlib?: NodeModule
+    inflateIfDeflated?: boolean
+  }
+>
+
+export = fastifyCompress

package.json

@@ -19,16 +19,22 @@
     "unzipper": "^0.9.11"
   },
   "devDependencies": {
+    "@types/node": "^11.13.9",
+    "@typescript-eslint/parser": "^1.7.0",
+    "eslint-plugin-typescript": "^0.14.0",
     "fastify": "^2.0.0",
     "iltorb": "^2.3.0",
     "jsonstream": "^1.0.3",
     "pre-commit": "^1.2.2",
     "standard": "^12.0.0",
+    "typescript": "^3.4.5",
     "tap": "^12.6.6"
   },
   "scripts": {
-    "unit": "tap test.js",
-    "test": "standard && npm run unit",
+    "unit": "tap test/test.js",
+    "test": "standard && npm run unit && npm run typescript",
+    "lint:typescript": "standard --fix --parser @typescript-eslint/parser --plugin typescript test/types/*.ts",
+    "typescript": "tsc --project ./test/types/tsconfig.json",
     "coverage": "npm run unit --  --cov",
     "coverage-report": "npm run coverage && tap --coverage-report=lcov"
   },

test.js renamed to test/test.js

@@ -9,7 +9,7 @@ const JSONStream = require('jsonstream')
 const createReadStream = fs.createReadStream
 const readFileSync = fs.readFileSync
 const Fastify = require('fastify')
-const compressPlugin = require('./index')
+const compressPlugin = require('../index')
 
 test('should send a deflated data', t => {
   t.plan(4)

test/types/index.ts

@@ -0,0 +1,16 @@
+import * as fastify from 'fastify'
+import * as fastifyCompress from '../..'
+
+const zlib = require('zlib')
+const iltorb = require('iltorb')
+
+const app = fastify()
+
+app.register(fastifyCompress, {
+  global: true,
+  threshold: 10,
+  brotli: iltorb,
+  zlib: zlib,
+  inflateIfDeflated: true,
+  customTypes: /x-protobuf$/
+})

test/types/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "noEmit": true,
+    "strict": true
+  },
+  "files": ["./index.ts"]
+}