feat: init types

Author: hubvue

package.json

@@ -5,8 +5,7 @@
   "main": "./lib/index.js",
   "types": "./dts/index.d.ts",
   "scripts": {
-    "build": "tsc",
-    "test": "echo text",
+    "build": "node ./scripts/build.js",
     "version": "conventional-changelog -p angular -i CHANGELOG.md -s && git add ./CHANGELOG.md",
     "format": "eslint --fix . --ext .js,.ts"
   },

scripts/build.js

@@ -1,5 +1,5 @@
 /**
- * @description 各可反射的常量标识
+ * @description 各个可反射的常量标识
  */
 export const META_ROUTER = Symbol.for('dectorator#meta_router')
 

src/constants/index.ts

@@ -1,19 +1,16 @@
 import * as Koa from 'koa'
 
 /**
- *
+ * @description controller的基础可继承类，继承自Koa。
  */
-export default class BaseController extends Koa {
+export class BaseController extends Koa {
   /**
-   *
+   * @description 使用继承的方式显示的让每一个controller可以从实例上获取到ctx和next
    */
   public ctx: Koa.Context
-  /**
-   *
-   */
   public next: Koa.Next
   /**
-   *
+   * @description controller继承baseController的标识
    */
   public _isExtends: symbol = Symbol.for('BaseController#isExtends')
 }

src/core/controller.ts

@@ -1,72 +1,62 @@
 import { instancePoll } from '../ioc'
 import { META_INJECT, META_CONTROLLER } from '../constants'
-import {
-  RuntimeOptionsInterface,
-  InjectInterface,
-  ControllerInterface
-} from '../interface'
+import { RuntimeOptions, InjectMetaType, ControllerInterface } from '../types'
 import KoaRuntime from '../runtime/koa'
 import * as Koa from 'koa'
 
 /**
- *
+ * @description controller poll，所有的controller都会注册到这里，在创建服务的时候获取到。
  */
 const CONTROLLER_POLL = Object.create(null)
 
 /**
- *
+ * @description 初始化所有的controller并将service注入去调用KoaRuntime启动服务。
  * @param options
  */
-type CreateApplicationType = (options: RuntimeOptionsInterface) => Koa
+type CreateApplicationType = (options: RuntimeOptions) => Koa
 export const createApplication: CreateApplicationType = (options = {}) => {
   const controllers: Set<any> = new Set()
-  const controllerPoll: Array<ControllerInterface> = Reflect.getMetadata(
-    META_CONTROLLER,
-    CONTROLLER_POLL
-  )
-  if (controllerPoll) {
-    for (let controllerMeta of controllerPoll) {
-      const { path, constructor } = controllerMeta
-      const controller = new constructor()
-      if (!('_isExtends' in controller)) {
-        throw new Error(`class ${constructor.name} not extends BaseController`)
-      }
-      const injects: Array<InjectInterface> = Reflect.getMetadata(
-        META_INJECT,
-        controller
-      )
-      if (injects) {
-        for (let inject of injects) {
-          const { propertyKey, tag } = inject
-          const injectable: new () => {} = instancePoll.get(tag)
-          if (injectable) {
-            Object.defineProperty(controller, propertyKey, {
-              value: new injectable(),
-              writable: false,
-              configurable: false,
-              enumerable: true
-            })
-          } else {
-            throw new Error(`not ${String(tag)} model is injectable`)
-          }
-        }
+  const controllerPoll: Array<ControllerInterface> =
+    Reflect.getMetadata(META_CONTROLLER, CONTROLLER_POLL) || []
+  // 遍历所有的controller，并获取到依赖的service。
+  for (let controllerMeta of controllerPoll) {
+    const { path, constructor } = controllerMeta
+    const controller = new constructor()
+    if (!('_isExtends' in controller)) {
+      throw new Error(`class ${constructor.name} not extends BaseController`)
+    }
+    const injects: Array<InjectMetaType> =
+      Reflect.getMetadata(META_INJECT, controller) || []
+    for (let inject of injects) {
+      const { propertyKey, tag } = inject
+      const injectable: new () => {} = instancePoll.get(tag)
+      if (injectable) {
+        Object.defineProperty(controller, propertyKey, {
+          value: new injectable(),
+          writable: false,
+          configurable: false,
+          enumerable: true
+        })
+      } else {
+        throw new Error(`not ${String(tag)} model is injectable`)
       }
-
-      controllers.add({
-        controller,
-        path
-      })
     }
+
+    controllers.add({
+      controller,
+      path
+    })
   }
+  // 调用KoaRuntime启动服务
   const app = KoaRuntime(controllers, options)
   return app
 }
 /**
- *
+ * controller的标示之一，将修饰的类注册到controller poll里
  * @param path
  */
-export const Controller = (path: string = '/'): Function => {
-  return function<T extends { new (...args: any[]): {} }>(constructor: T) {
+export const Controller = (path: string = '/'): ClassDecorator => {
+  return function(constructor) {
     const controllerPoll: Array<ControllerInterface> = Reflect.getMetadata(
       META_CONTROLLER,
       CONTROLLER_POLL

src/core/index.ts

@@ -1,43 +1,43 @@
 import { META_ROUTER } from '../constants'
-import { RouteAopInterface } from '../interface'
+import { RouteAop } from '../types'
 import { Middleware } from 'koa'
 // create http request method decorator
 /**
- *
+ * @description get router
  */
 export const Get = createHTTPMethodDecorator('get')
 /**
- *
+ * @description post router
  */
 export const Post = createHTTPMethodDecorator('post')
 /**
- *
+ * @description put router
  */
 export const Put = createHTTPMethodDecorator('put')
 /**
- *
+ *  @description delete router
  */
 export const Delete = createHTTPMethodDecorator('delete')
 /**
- *
+ * @description all router
  */
 export const All = createHTTPMethodDecorator('get', 'post', 'put', 'delete')
 
 /**
- *
+ * @description 路由装饰器生成器
  * @param methods
  */
 type HttpMethodReturnType = (
   path: string,
-  aopPlugins?: RouteAopInterface
+  aopPlugins?: RouteAop
 ) => MethodDecorator
 function createHTTPMethodDecorator(
   ...methods: Array<string>
 ): HttpMethodReturnType {
   return (path, aopPlugins = {}): MethodDecorator => (
-    target: any,
-    propertyKey: string,
-    descripator: PropertyDescriptor
+    target,
+    propertyKey,
+    descripator
   ) => {
     let beforePlugins: Set<Middleware> = new Set()
     let afterPlugins: Set<Middleware> = new Set()

src/decorator/httpRouter.ts

@@ -1,14 +1,15 @@
 import { META_HEADERS } from '../../constants'
-import { ParamsMetaInterface } from '../../interface'
+import { ParamsMetaInterface } from '../../types'
 import { Context } from 'koa'
 /**
- *
+ * @description 路由函数参数装饰器，可直接获取到请求的header
  * @param headers
  */
-export const Headers = (tags: Array<string> = []) => (
-  target: any,
-  propertyKey: string,
-  paramIndex: number
+type HeadersType = (tags: Array<string>) => ParameterDecorator
+export const Headers: HeadersType = (tags = []) => (
+  target,
+  propertyKey,
+  paramIndex
 ) => {
   Reflect.defineMetadata(
     META_HEADERS,
@@ -21,14 +22,16 @@ export const Headers = (tags: Array<string> = []) => (
 }
 
 /**
- *
+ * @description 获取header的辅助函数
  * @param ctx
  * @param paramMeta
  */
-export const getHeadersHandler = (
+type HeadersHandlerType = (
   ctx: Context,
   paramMeta: ParamsMetaInterface
-): Array<any> => {
+) => Array<any>
+
+export const getHeadersHandler: HeadersHandlerType = (ctx, paramMeta) => {
   const { index, tags } = paramMeta
   const rawHeaders = ctx.req.headers
   let result

src/decorator/params/headers.ts

@@ -1,19 +1,26 @@
 import { META_REQ, META_RES, META_COOKIE } from '../../constants'
 import { Headers, getHeadersHandler } from './headers'
 import { Params, getParamsHeandler } from './params'
+/**
+ * get request
+ */
 const Req = createParamDecorator(META_REQ)
 
+/**
+ * get response
+ */
 const Res = createParamDecorator(META_RES)
-
+/**
+ * get cookie
+ */
 const Cookie = createParamDecorator(META_COOKIE)
 
 /**
- *
+ * @description 基础参数装饰器生成器
  * @param key
- *
  */
 function createParamDecorator(key: symbol) {
-  return () => (target: any, propertyKey: string, paramIndex: number) => {
+  return (): ParameterDecorator => (target, propertyKey, paramIndex) => {
     Reflect.defineMetadata(key, paramIndex, target[propertyKey])
   }
 }

src/decorator/params/index.ts

@@ -1,10 +1,16 @@
 import { Context } from 'koa'
 import { META_PARAMS } from '../../constants'
-import { ParamsMetaInterface } from '../../interface'
-export const Params = (tags: Array<string> = []) => (
-  target: any,
-  propertyKey: string,
-  paramIndex: number
+import { ParamsMetaInterface } from '../../types'
+
+/**
+ * @description 请求参数装饰器
+ * @param tags
+ */
+type ParamsType = (tags: Array<string>) => ParameterDecorator
+export const Params: ParamsType = (tags = []) => (
+  target,
+  propertyKey,
+  paramIndex
 ) => {
   Reflect.defineMetadata(
     META_PARAMS,
@@ -16,10 +22,16 @@ export const Params = (tags: Array<string> = []) => (
   )
 }
 
-export const getParamsHeandler = (
+/**
+ * @description 请求参数装饰器服务函数
+ * @param ctx
+ * @param paramMeta
+ */
+type ParamsHeandlerType = (
   ctx: Context,
   paramMeta: ParamsMetaInterface
-): Array<any> => {
+) => Array<any>
+export const getParamsHeandler: ParamsHeandlerType = (ctx, paramMeta) => {
   const { index, tags } = paramMeta
   const allParams = {
     body: ctx.request.body,

src/decorator/params/params.ts

@@ -1,37 +1,11 @@
 import 'reflect-metadata'
-/**
- *
- */
-import { Inject, Injectable } from './ioc'
-/**
- *
- */
-import { Get, Post, Put, Delete, All } from './decorator/httpRouter'
-/**
- *
- */
-import { createApplication, Controller } from './core'
-/**
- *
- */
-import BaseController from './core/controller'
 
-import { Headers, Params, Cookie, Req, Res } from './decorator/params'
+export * from './ioc'
 
-export {
-  createApplication,
-  BaseController,
-  Controller,
-  Inject,
-  Injectable,
-  Get,
-  Post,
-  Put,
-  Delete,
-  All,
-  Headers,
-  Params,
-  Cookie,
-  Req,
-  Res
-}
+export * from './decorator/httpRouter'
+
+export * from './core'
+
+export * from './core/controller'
+
+export * from './decorator/params'