koatty 3.5.12-1 → 3.5.12-2

package/docs/api/koatty.httpcontroller.json.md

@@ -1,26 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [HttpController](./koatty.httpcontroller.md) &gt; [json](./koatty.httpcontroller.json.md)
-
-## HttpController.json() method
-
-Respond to json formatted content
-
-<b>Signature:</b>
-
-```typescript
-json(data: any): Promise<any>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  data | any |  |
-
-<b>Returns:</b>
-
-Promise&lt;any&gt;
-
-{<!-- -->Promise<any>}  HttpController
-

package/docs/api/koatty.httpcontroller.md

@@ -1,35 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [HttpController](./koatty.httpcontroller.md)
-
-## HttpController class
-
-HTTP controller
-
-  HttpController  {<!-- -->IController<!-- -->}
-
-<b>Signature:</b>
-
-```typescript
-export declare class HttpController extends BaseController 
-```
-<b>Extends:</b> [BaseController](./koatty.basecontroller.md)
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [body(data, contentType, encoding)](./koatty.httpcontroller.body.md) |  | Set response Body content |
-|  [deny(code)](./koatty.httpcontroller.deny.md) |  | Block access |
-|  [expires(timeout)](./koatty.httpcontroller.expires.md) |  | set cache-control and expires header |
-|  [fail(msg, data, code)](./koatty.httpcontroller.fail.md) |  | Response to normalize json format content for fail |
-|  [header(name, value)](./koatty.httpcontroller.header.md) |  | Get/Set headers. |
-|  [isGet()](./koatty.httpcontroller.isget.md) |  | Whether it is a GET request |
-|  [isMethod(method)](./koatty.httpcontroller.ismethod.md) |  | Determines whether the METHOD request is specified |
-|  [isPost()](./koatty.httpcontroller.ispost.md) |  | Whether it is a POST request |
-|  [json(data)](./koatty.httpcontroller.json.md) |  | Respond to json formatted content |
-|  [ok(msg, data, code)](./koatty.httpcontroller.ok.md) |  | Response to normalize json format content for success |
-|  [param(name)](./koatty.httpcontroller.param.md) |  | Get POST/GET parameters, the POST value is priority. |
-|  [redirect(urls, alt)](./koatty.httpcontroller.redirect.md) |  | Url redirect |
-|  [type(contentType, encoding)](./koatty.httpcontroller.type.md) |  | Set response content-type |
-

package/docs/api/koatty.httpcontroller.ok.md

@@ -1,28 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [HttpController](./koatty.httpcontroller.md) &gt; [ok](./koatty.httpcontroller.ok.md)
-
-## HttpController.ok() method
-
-Response to normalize json format content for success
-
-<b>Signature:</b>
-
-```typescript
-ok(msg: string | ApiInput, data?: any, code?: number): Promise<any>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  msg | string \| [ApiInput](./koatty.apiinput.md) | 待处理的message消息 |
-|  data | any | 待处理的数据 |
-|  code | number | 错误码，默认0 |
-
-<b>Returns:</b>
-
-Promise&lt;any&gt;
-
-{<!-- -->\*<!-- -->}  HttpController
-

package/docs/api/koatty.httpcontroller.param.md

@@ -1,26 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [HttpController](./koatty.httpcontroller.md) &gt; [param](./koatty.httpcontroller.param.md)
-
-## HttpController.param() method
-
-Get POST/GET parameters, the POST value is priority.
-
-<b>Signature:</b>
-
-```typescript
-param(name?: string): any;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  name | string |  |
-
-<b>Returns:</b>
-
-any
-
- HttpController
-

package/docs/api/koatty.httpcontroller.redirect.md

@@ -1,27 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [HttpController](./koatty.httpcontroller.md) &gt; [redirect](./koatty.httpcontroller.redirect.md)
-
-## HttpController.redirect() method
-
-Url redirect
-
-<b>Signature:</b>
-
-```typescript
-redirect(urls: string, alt?: string): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  urls | string |  |
-|  alt | string |  |
-
-<b>Returns:</b>
-
-void
-
-{<!-- -->void<!-- -->}  HttpController
-

package/docs/api/koatty.httpcontroller.type.md

@@ -1,27 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [HttpController](./koatty.httpcontroller.md) &gt; [type](./koatty.httpcontroller.type.md)
-
-## HttpController.type() method
-
-Set response content-type
-
-<b>Signature:</b>
-
-```typescript
-type(contentType: string, encoding?: string | boolean): string;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  contentType | string |  |
-|  encoding | string \| boolean |  |
-
-<b>Returns:</b>
-
-string
-
-{<!-- -->string<!-- -->}  HttpController
-

package/docs/api/koatty.icontroller.__after.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IController](./koatty.icontroller.md) &gt; [\_\_after](./koatty.icontroller.__after.md)
-
-## IController.\_\_after property
-
-<b>Signature:</b>
-
-```typescript
-__after?: () => Promise<any>;
-```

package/docs/api/koatty.icontroller.__befor.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IController](./koatty.icontroller.md) &gt; [\_\_befor](./koatty.icontroller.__befor.md)
-
-## IController.\_\_befor property
-
-<b>Signature:</b>
-
-```typescript
-__befor?: () => Promise<any>;
-```

package/docs/api/koatty.icontroller.app.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IController](./koatty.icontroller.md) &gt; [app](./koatty.icontroller.app.md)
-
-## IController.app property
-
-<b>Signature:</b>
-
-```typescript
-app: Koatty;
-```

package/docs/api/koatty.icontroller.ctx.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IController](./koatty.icontroller.md) &gt; [ctx](./koatty.icontroller.ctx.md)
-
-## IController.ctx property
-
-<b>Signature:</b>
-
-```typescript
-readonly ctx: KoattyContext;
-```

package/docs/api/koatty.icontroller.fail.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IController](./koatty.icontroller.md) &gt; [fail](./koatty.icontroller.fail.md)
-
-## IController.fail property
-
-<b>Signature:</b>
-
-```typescript
-readonly fail: (msg?: Error | string | ApiInput, data?: any, ret?: number) => Promise<any>;
-```

package/docs/api/koatty.icontroller.md

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IController](./koatty.icontroller.md)
-
-## IController interface
-
-Interface for Controller
-
-<b>Signature:</b>
-
-```typescript
-export interface IController 
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [\_\_after?](./koatty.icontroller.__after.md) | () =&gt; Promise&lt;any&gt; | <i>(Optional)</i> |
-|  [\_\_befor?](./koatty.icontroller.__befor.md) | () =&gt; Promise&lt;any&gt; | <i>(Optional)</i> |
-|  [app](./koatty.icontroller.app.md) | Koatty |  |
-|  [ctx](./koatty.icontroller.ctx.md) | KoattyContext |  |
-|  [fail](./koatty.icontroller.fail.md) | (msg?: Error \| string \| [ApiInput](./koatty.apiinput.md)<!-- -->, data?: any, ret?: number) =&gt; Promise&lt;any&gt; |  |
-|  [ok](./koatty.icontroller.ok.md) | (msg?: string \| [ApiInput](./koatty.apiinput.md)<!-- -->, data?: any, ret?: number) =&gt; Promise&lt;any&gt; |  |
-

package/docs/api/koatty.icontroller.ok.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IController](./koatty.icontroller.md) &gt; [ok](./koatty.icontroller.ok.md)
-
-## IController.ok property
-
-<b>Signature:</b>
-
-```typescript
-readonly ok: (msg?: string | ApiInput, data?: any, ret?: number) => Promise<any>;
-```

package/docs/api/koatty.imiddleware.md

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IMiddleware](./koatty.imiddleware.md)
-
-## IMiddleware interface
-
-Interface for Middleware
-
-<b>Signature:</b>
-
-```typescript
-export interface IMiddleware 
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [run](./koatty.imiddleware.run.md) | (options: any, app: Koatty) =&gt; Koa.Middleware |  |
-

package/docs/api/koatty.imiddleware.run.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IMiddleware](./koatty.imiddleware.md) &gt; [run](./koatty.imiddleware.run.md)
-
-## IMiddleware.run property
-
-<b>Signature:</b>
-
-```typescript
-run: (options: any, app: Koatty) => Koa.Middleware;
-```

package/docs/api/koatty.iplugin.md

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IPlugin](./koatty.iplugin.md)
-
-## IPlugin interface
-
-Interface for Plugin
-
-<b>Signature:</b>
-
-```typescript
-export interface IPlugin 
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [run](./koatty.iplugin.run.md) | (options: any, app: Koatty) =&gt; Promise&lt;any&gt; |  |
-

package/docs/api/koatty.iplugin.run.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IPlugin](./koatty.iplugin.md) &gt; [run](./koatty.iplugin.run.md)
-
-## IPlugin.run property
-
-<b>Signature:</b>
-
-```typescript
-run: (options: any, app: Koatty) => Promise<any>;
-```

package/docs/api/koatty.iservice.app.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IService](./koatty.iservice.md) &gt; [app](./koatty.iservice.app.md)
-
-## IService.app property
-
-<b>Signature:</b>
-
-```typescript
-app: Koatty;
-```

package/docs/api/koatty.iservice.md

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [IService](./koatty.iservice.md)
-
-## IService interface
-
-Interface for Service
-
-<b>Signature:</b>
-
-```typescript
-export interface IService 
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [app](./koatty.iservice.app.md) | Koatty |  |
-

package/docs/api/koatty.logger.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [Logger](./koatty.logger.md)
-
-## Logger variable
-
-<b>Signature:</b>
-
-```typescript
-Logger: import("koatty_logger").Logger
-```

package/docs/api/koatty.md

@@ -1,51 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md)
-
-## koatty package
-
-## Classes
-
-|  Class | Description |
-|  --- | --- |
-|  [BaseController](./koatty.basecontroller.md) | Base controller  BaseController  {<!-- -->IController<!-- -->} |
-|  [BaseService](./koatty.baseservice.md) | Base class  Base |
-|  [HttpController](./koatty.httpcontroller.md) | HTTP controller  HttpController  {<!-- -->IController<!-- -->} |
-
-## Functions
-
-|  Function | Description |
-|  --- | --- |
-|  [BindAppReadyHook(func, target)](./koatty.bindappreadyhook.md) | bind AppReadyHookFunc example: export function TestDecorator(): ClassDecorator { return (target: any) =<!-- -->&gt; { BindAppReadyHook((app: Koatty) =<!-- -->&gt; { // todo return Promise.resolve(); }<!-- -->, target) } } |
-|  [Bootstrap(bootFunc)](./koatty.bootstrap.md) | Bootstrap application |
-|  [Component(identifier)](./koatty.component.md) | Indicates that an decorated class is a "component". |
-|  [ComponentScan(scanPath)](./koatty.componentscan.md) | Define project scan path |
-|  [ConfigurationScan(scanPath)](./koatty.configurationscan.md) | Define project configuration scan path |
-|  [Controller(path)](./koatty.controller.md) | Indicates that an decorated class is a "controller". |
-|  [Middleware(identifier)](./koatty.middleware.md) | Indicates that an decorated class is a "middleware". |
-|  [Plugin(identifier)](./koatty.plugin.md) | Indicates that an decorated class is a "plugin". |
-|  [Service(identifier)](./koatty.service.md) | Indicates that an decorated class is a "service". |
-
-## Interfaces
-
-|  Interface | Description |
-|  --- | --- |
-|  [ApiInput](./koatty.apiinput.md) | Interface for Api input |
-|  [ApiOutput](./koatty.apioutput.md) | Interface for Api output |
-|  [IController](./koatty.icontroller.md) | Interface for Controller |
-|  [IMiddleware](./koatty.imiddleware.md) | Interface for Middleware |
-|  [IPlugin](./koatty.iplugin.md) | Interface for Plugin |
-|  [IService](./koatty.iservice.md) | Interface for Service |
-
-## Variables
-
-|  Variable | Description |
-|  --- | --- |
-|  [Logger](./koatty.logger.md) |  |
-
-## Type Aliases
-
-|  Type Alias | Description |
-|  --- | --- |
-|  [AppReadyHookFunc](./koatty.appreadyhookfunc.md) |  |
-

package/docs/api/koatty.middleware.md

@@ -1,27 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [Middleware](./koatty.middleware.md)
-
-## Middleware() function
-
-Indicates that an decorated class is a "middleware".
-
-
-<b>Signature:</b>
-
-```typescript
-export declare function Middleware(identifier?: string): ClassDecorator;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  identifier | string | middleware name |
-
-<b>Returns:</b>
-
-ClassDecorator
-
-{<!-- -->ClassDecorator<!-- -->}
-

package/docs/api/koatty.plugin.md

@@ -1,27 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [Plugin](./koatty.plugin.md)
-
-## Plugin() function
-
-Indicates that an decorated class is a "plugin".
-
-
-<b>Signature:</b>
-
-```typescript
-export declare function Plugin(identifier?: string): ClassDecorator;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  identifier | string |  |
-
-<b>Returns:</b>
-
-ClassDecorator
-
-{<!-- -->ClassDecorator<!-- -->}
-

package/docs/api/koatty.service.md

@@ -1,27 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [Service](./koatty.service.md)
-
-## Service() function
-
-Indicates that an decorated class is a "service".
-
-
-<b>Signature:</b>
-
-```typescript
-export declare function Service(identifier?: string): ClassDecorator;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  identifier | string | middleware name |
-
-<b>Returns:</b>
-
-ClassDecorator
-
-{<!-- -->ClassDecorator<!-- -->}
-

package/jest.config.js

@@ -1,34 +0,0 @@
-/**
- * 
- */
-
-// jest详细配置参见:
-// https://jestjs.io/docs/en/configuration.html
-
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node', // 测试用例运行环境
-  testMatch: ['<rootDir>/test/**/*.(spec|test).[jt]s'], // 匹配测试用例的路径规则
-  reporters: [
-    'default',
-    'jest-html-reporters'
-  ], // 测试用例报告
-  collectCoverage: true, // 是否收集测试时的覆盖率信息
-  coverageReporters: [
-    'html',
-    'lcov',
-    'json',
-    'text',
-    'clover',
-    'text-summary',
-  ], // 收集测试时的覆盖率信息
-  // 将 `ts-jest` 的配置注入到运行时的全局变量中
-  globals: {
-    'ts-jest': {
-      // 编译 Typescript 所依赖的配置
-      tsconfig: '<rootDir>/tsconfig.json',
-      // 是否启用报告诊断，这里是不启用
-      diagnostics: false,
-    },
-  }
-};