Add TypeScript (#46)

Author: ifaisalalam

index.d.ts

@@ -0,0 +1,28 @@
+import * as Fastify from 'fastify';
+import { Redis, RedisOptions } from 'ioredis';
+
+import { Server, IncomingMessage, ServerResponse } from 'http';
+import { Http2Server, Http2SecureServer, Http2ServerRequest, Http2ServerResponse } from 'http2';
+
+declare module 'fastify' {
+  interface FastifyInstance<HttpServer, HttpRequest, HttpResponse> {
+    redis: Redis;
+  }
+}
+
+declare interface FastifyRedisPlugin<HttpServer, HttpRequest, HttpResponse>
+  extends Fastify.Plugin<
+    HttpServer,
+    HttpRequest,
+    HttpResponse,
+    RedisOptions | { client: Redis }
+  > {}
+
+
+declare const fastifyRedis: FastifyRedisPlugin<
+  Server | Http2Server | Http2SecureServer,
+  IncomingMessage | Http2ServerRequest,
+  ServerResponse | Http2ServerResponse
+>;
+
+export = fastifyRedis;

package.json

@@ -3,10 +3,12 @@
   "version": "3.2.0",
   "description": "Plugin to share a common Redis connection across Fastify.",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
-    "test": "npm run lint && npm run unit",
+    "test": "npm run lint && npm run unit && npm run typescript",
     "lint": "standard",
     "unit": "tap test.js",
+    "typescript": "tsc --project ./test/types/tsconfig.json",
     "redis": "docker run -p 6379:6379 --rm redis:5"
   },
   "repository": {
@@ -28,6 +30,8 @@
   },
   "homepage": "https://github.com/fastify/fastify-redis#readme",
   "devDependencies": {
+    "@types/ioredis": "^4.0.18",
+    "@types/node": "^12.11.1",
     "fastify": "^2.5.0",
     "redis": "^2.8.0",
     "standard": "^14.0.2",

test.js renamed to test/test.js

@@ -3,7 +3,7 @@
 const t = require('tap')
 const test = t.test
 const Fastify = require('fastify')
-const fastifyRedis = require('./index')
+const fastifyRedis = require('../index')
 
 t.beforeEach((done) => {
   const fastify = Fastify()

test/types/index.ts

@@ -0,0 +1,30 @@
+import * as Fastify from 'fastify';
+import * as fastifyRedis from '../..';
+import * as IORedis from 'ioredis';
+
+import * as http from 'http';
+import * as http2 from 'http2';
+
+const app: Fastify.FastifyInstance<
+    http.Server | http2.Http2Server | http2.Http2SecureServer,
+    http.IncomingMessage | http2.Http2ServerRequest,
+    http.ServerResponse | http2.Http2ServerResponse
+    > = Fastify();
+const redis = new IORedis({ host: 'localhost', port: 6379 });
+
+app.register(fastifyRedis, { host: '127.0.0.1' });
+app.register(fastifyRedis, { client: redis });
+
+app.get('/foo', (req, reply) => {
+  const { redis } = app;
+  redis.get(req.query.key, (err, val) => {
+    reply.send(err || val);
+  });
+});
+
+app.post('/foo', (req, reply) => {
+  const { redis } = app;
+  redis.set(req.body.key, req.body.value, err => {
+    reply.send(err || { status: 'ok' });
+  });
+});

test/types/tsconfig.json

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