koatty 3.5.12-1 → 3.5.14

package/docs/api/koatty.baseservice._constructor_.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; [BaseService](./koatty.baseservice.md) &gt; [(constructor)](./koatty.baseservice._constructor_.md)
-
-## BaseService.(constructor)
-
-instance of Base.
-
-<b>Signature:</b>
-
-```typescript
-protected constructor(...arg: any[]);
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  arg | any\[\] |  Base |
-

package/docs/api/koatty.baseservice._options.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; [BaseService](./koatty.baseservice.md) &gt; [\_options](./koatty.baseservice._options.md)
-
-## BaseService.\_options property
-
-<b>Signature:</b>
-
-```typescript
-protected _options: ObjectDefinitionOptions;
-```

package/docs/api/koatty.baseservice.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; [BaseService](./koatty.baseservice.md) &gt; [app](./koatty.baseservice.app.md)
-
-## BaseService.app property
-
-<b>Signature:</b>
-
-```typescript
-app: Koatty;
-```

package/docs/api/koatty.baseservice.init.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; [BaseService](./koatty.baseservice.md) &gt; [init](./koatty.baseservice.init.md)
-
-## BaseService.init() method
-
-init
-
-
-<b>Signature:</b>
-
-```typescript
-protected init(...arg: any[]): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  arg | any\[\] |  Base |
-
-<b>Returns:</b>
-
-void
-

package/docs/api/koatty.baseservice.md

@@ -1,36 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [koatty](./koatty.md) &gt; [BaseService](./koatty.baseservice.md)
-
-## BaseService class
-
-Base class
-
-  Base
-
-<b>Signature:</b>
-
-```typescript
-export declare class BaseService implements IService 
-```
-<b>Implements:</b> [IService](./koatty.iservice.md)
-
-## Constructors
-
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(arg)](./koatty.baseservice._constructor_.md) |  | instance of Base. |
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [\_options](./koatty.baseservice._options.md) |  | ObjectDefinitionOptions |  |
-|  [app](./koatty.baseservice.app.md) |  | Koatty |  |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [init(arg)](./koatty.baseservice.init.md) |  | init |
-

package/docs/api/koatty.bindappreadyhook.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; [BindAppReadyHook](./koatty.bindappreadyhook.md)
-
-## BindAppReadyHook() function
-
-bind AppReadyHookFunc example: export function TestDecorator(): ClassDecorator { return (target: any) =<!-- -->&gt; { BindAppReadyHook((app: Koatty) =<!-- -->&gt; { // todo return Promise.resolve(); }<!-- -->, target) } }
-
-
-<b>Signature:</b>
-
-```typescript
-export declare function BindAppReadyHook(func: AppReadyHookFunc, target: any): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  func | [AppReadyHookFunc](./koatty.appreadyhookfunc.md) |  |
-|  target | any |  |
-
-<b>Returns:</b>
-
-void
-

package/docs/api/koatty.bootstrap.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; [Bootstrap](./koatty.bootstrap.md)
-
-## Bootstrap() function
-
-Bootstrap application
-
-
-<b>Signature:</b>
-
-```typescript
-export declare function Bootstrap(bootFunc?: Function): ClassDecorator;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  bootFunc | Function |  |
-
-<b>Returns:</b>
-
-ClassDecorator
-
-{<!-- -->ClassDecorator<!-- -->}
-

package/docs/api/koatty.component.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; [Component](./koatty.component.md)
-
-## Component() function
-
-Indicates that an decorated class is a "component".
-
-
-<b>Signature:</b>
-
-```typescript
-export declare function Component(identifier?: string): ClassDecorator;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  identifier | string | component name |
-
-<b>Returns:</b>
-
-ClassDecorator
-
-{<!-- -->ClassDecorator<!-- -->}
-

package/docs/api/koatty.componentscan.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; [ComponentScan](./koatty.componentscan.md)
-
-## ComponentScan() function
-
-Define project scan path
-
-
-<b>Signature:</b>
-
-```typescript
-export declare function ComponentScan(scanPath?: string | string[]): ClassDecorator;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  scanPath | string \| string\[\] |  |
-
-<b>Returns:</b>
-
-ClassDecorator
-
-{<!-- -->ClassDecorator<!-- -->}
-

package/docs/api/koatty.configurationscan.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; [ConfigurationScan](./koatty.configurationscan.md)
-
-## ConfigurationScan() function
-
-Define project configuration scan path
-
-
-<b>Signature:</b>
-
-```typescript
-export declare function ConfigurationScan(scanPath?: string | string[]): ClassDecorator;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  scanPath | string \| string\[\] |  |
-
-<b>Returns:</b>
-
-ClassDecorator
-
-{<!-- -->ClassDecorator<!-- -->}
-

package/docs/api/koatty.controller.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; [Controller](./koatty.controller.md)
-
-## Controller() function
-
-Indicates that an decorated class is a "controller".
-
-
-<b>Signature:</b>
-
-```typescript
-export declare function Controller(path?: string): ClassDecorator;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  path | string | controller router path |
-
-<b>Returns:</b>
-
-ClassDecorator
-
-{<!-- -->ClassDecorator<!-- -->}
-

package/docs/api/koatty.httpcontroller.body.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; [body](./koatty.httpcontroller.body.md)
-
-## HttpController.body() method
-
-Set response Body content
-
-<b>Signature:</b>
-
-```typescript
-body(data: any, contentType?: string, encoding?: string): Promise<any>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  data | any |  |
-|  contentType | string |  |
-|  encoding | string |  |
-
-<b>Returns:</b>
-
-Promise&lt;any&gt;
-
-{<!-- -->Promise<any>}  HttpController
-

package/docs/api/koatty.httpcontroller.deny.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; [deny](./koatty.httpcontroller.deny.md)
-
-## HttpController.deny() method
-
-Block access
-
-<b>Signature:</b>
-
-```typescript
-deny(code?: number): Promise<any>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  code | number |  |
-
-<b>Returns:</b>
-
-Promise&lt;any&gt;
-
-{<!-- -->Promise<any>}  HttpController
-

package/docs/api/koatty.httpcontroller.expires.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; [expires](./koatty.httpcontroller.expires.md)
-
-## HttpController.expires() method
-
-set cache-control and expires header
-
-<b>Signature:</b>
-
-```typescript
-expires(timeout?: number): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  timeout | number |  |
-
-<b>Returns:</b>
-
-void
-
-{<!-- -->void<!-- -->}  HttpController
-

package/docs/api/koatty.httpcontroller.fail.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; [fail](./koatty.httpcontroller.fail.md)
-
-## HttpController.fail() method
-
-Response to normalize json format content for fail
-
-<b>Signature:</b>
-
-```typescript
-fail(msg: Error | string | ApiInput, data?: any, code?: number): Promise<any>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  msg | Error \| string \| [ApiInput](./koatty.apiinput.md) |  |
-|  data | any |  |
-|  code | number |  |
-
-<b>Returns:</b>
-
-Promise&lt;any&gt;
-
-{<!-- -->\*<!-- -->}  HttpController
-

package/docs/api/koatty.httpcontroller.header.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; [header](./koatty.httpcontroller.header.md)
-
-## HttpController.header() method
-
-Get/Set headers.
-
-<b>Signature:</b>
-
-```typescript
-header(name?: string, value?: any): any;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  name | string |  |
-|  value | any |  |
-
-<b>Returns:</b>
-
-any
-
-{<!-- -->\*<!-- -->}  HttpController
-

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

@@ -1,19 +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; [isGet](./koatty.httpcontroller.isget.md)
-
-## HttpController.isGet() method
-
-Whether it is a GET request
-
-<b>Signature:</b>
-
-```typescript
-isGet(): boolean;
-```
-<b>Returns:</b>
-
-boolean
-
-{<!-- -->boolean<!-- -->}  HttpController
-

package/docs/api/koatty.httpcontroller.ismethod.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; [isMethod](./koatty.httpcontroller.ismethod.md)
-
-## HttpController.isMethod() method
-
-Determines whether the METHOD request is specified
-
-<b>Signature:</b>
-
-```typescript
-isMethod(method: string): boolean;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  method | string |  |
-
-<b>Returns:</b>
-
-boolean
-
-{<!-- -->boolean<!-- -->}  HttpController
-

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

@@ -1,19 +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; [isPost](./koatty.httpcontroller.ispost.md)
-
-## HttpController.isPost() method
-
-Whether it is a POST request
-
-<b>Signature:</b>
-
-```typescript
-isPost(): boolean;
-```
-<b>Returns:</b>
-
-boolean
-
-{<!-- -->boolean<!-- -->}  HttpController
-

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>;
-```