feat: add typescript support (#6)

index.d.ts

@@ -0,0 +1,27 @@
+declare module 'egg' {
+  export interface EggAppConfig {
+    sessionRedis: {
+      name: string
+    }
+  }
+
+  export interface Application {
+    /**
+     * @member Application#sessionStore
+     * @property {Function<string>} get - get redis session store
+     * @property {Function<string, any, number?>} set - set the redis session store
+     * @property {Function<string>} destroy - destroy of redis session store
+     * @example
+     * ```js
+     * this.app.sessionStore.set('SESSION_KEY', { a: 1 }, 6000);
+     * this.app.sessionStore.get('SESSION_KEY');
+     * this.app.sessionStore.destroy('SESSION_KEY');
+     * ```
+     */
+    sessionStore: {
+      get: (key: string) => Promise<any>;
+      set: (key: string, value: any, maxAge?: number | string) => Promise<void>;
+      destroy: (key: string) => Promise<void>;
+    };
+  }
+}

package.json

@@ -26,7 +26,9 @@
     "eslint": "^4.19.1",
     "eslint-config-egg": "^7.0.0",
     "mz-modules": "^2.1.0",
+    "runscript": "^1.3.0",
     "supertest": "^3.1.0",
+    "typescript": "^3.0.3",
     "webstorm-disable-index": "^1.2.0"
   },
   "engines": {
@@ -40,8 +42,10 @@
     "ci": "npm run lint && npm run cov",
     "autod": "autod"
   },
+  "types": "index.d.ts",
   "files": [
     "index.js",
+    "index.d.ts",
     "app.js",
     "agent.js",
     "config",

test/app.test.js

@@ -2,14 +2,22 @@
 
 const sleep = require('mz-modules/sleep');
 const request = require('supertest');
+const runscript = require('runscript');
 const assert = require('assert');
 const mm = require('egg-mock');
+const path = require('path');
+const tsBaseDir = path.join(__dirname, './fixtures/ts');
 
 describe('app.test.js', () => {
+  // add typescript tsc
+  before(async () => {
+    await runscript(`tsc -p ${tsBaseDir}/tsconfig.json`, { cwd: tsBaseDir });
+  });
 
   [
     'single',
     'multi',
+    'ts',
   ].forEach(name => {
     describe(name, () => {
       let app;

test/fixtures/ts/.gitignore

@@ -0,0 +1 @@
+*.js

test/fixtures/ts/app/controller/home.ts

@@ -0,0 +1,34 @@
+import { Controller } from 'egg';
+
+// add home controller
+declare module 'egg' {
+  interface IController {
+    home: HomeController;
+  }
+}
+
+export default class HomeController extends Controller {
+  async get () {
+    this.ctx.body = this.ctx.session;
+  };
+
+  async set () {
+    this.ctx.session = this.ctx.query;
+    this.ctx.body = this.ctx.session;
+  };
+
+  async setKey () {
+    this.ctx.session.key = this.ctx.query.key;
+    this.ctx.body = this.ctx.session;
+  };
+
+  async remove () {
+    this.ctx.session = null;
+    this.ctx.body = this.ctx.session;
+  };
+
+  async maxAge () {
+    this.ctx.session.maxAge = Number(this.ctx.query.maxAge);
+    this.ctx.body = this.ctx.session;
+  };
+}

test/fixtures/ts/app/router.ts

@@ -0,0 +1,10 @@
+import { Application } from 'egg';
+
+export default (app: Application) => {
+  const controller = app.controller;
+  app.get('/get', controller.home.get);
+  app.get('/set', controller.home.set);
+  app.get('/setKey', controller.home.setKey);
+  app.get('/remove', controller.home.remove);
+  app.get('/maxAge', controller.home.maxAge);
+}

test/fixtures/ts/config/config.ts

@@ -0,0 +1,11 @@
+export default {
+  keys: 'keys',
+  redis: {
+    client: {
+      host: '127.0.0.1',
+      port: 6379,
+      db: '0',
+      password: '',
+    },
+  }
+}

test/fixtures/ts/config/plugin.ts

@@ -0,0 +1,10 @@
+import { EggPlugin } from 'egg';
+
+const plugin: EggPlugin = {
+  redis: {
+    enable: true,
+    package: 'egg-redis',
+  }
+};
+
+export default plugin;

test/fixtures/ts/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "ts",
+  "version": "1.0.0"
+}

test/fixtures/ts/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "baseUrl": ".",
+    "module": "commonjs",
+    "lib": ["es7"],
+    "strict": true
+  },
+  "include": [
+    "../../../**/*"
+  ]
+}