koatty 3.5.11 → 3.5.12-0

package/docs/api/koatty.controller.md

@@ -0,0 +1,27 @@
+<!-- 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

@@ -0,0 +1,28 @@
+<!-- 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

@@ -0,0 +1,26 @@
+<!-- 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

@@ -0,0 +1,26 @@
+<!-- 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

@@ -0,0 +1,28 @@
+<!-- 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

@@ -0,0 +1,27 @@
+<!-- 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

@@ -0,0 +1,19 @@
+<!-- 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

@@ -0,0 +1,26 @@
+<!-- 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

@@ -0,0 +1,19 @@
+<!-- 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

@@ -0,0 +1,26 @@
+<!-- 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

@@ -0,0 +1,35 @@
+<!-- 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

@@ -0,0 +1,28 @@
+<!-- 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

@@ -0,0 +1,26 @@
+<!-- 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

@@ -0,0 +1,27 @@
+<!-- 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

@@ -0,0 +1,27 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,25 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,20 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,20 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,20 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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
+```