@maiyunnet/kebab 7.6.1 → 7.6.3

package/doc/sc/api/sys/mod/index.md

@@ -1,21 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../index.md) / sys/mod
-
-# sys/mod
-
-## Classes
-
-- [default](classes/default.md)
-- [Rows](classes/Rows.md)
-
-## Interfaces
-
-- [IModUnionItem](interfaces/IModUnionItem.md)
-- [IRows](interfaces/IRows.md)
-
-## Type Aliases
-
-- [TOnlyProperties](type-aliases/TOnlyProperties.md)

package/doc/sc/api/sys/mod/interfaces/IModUnionItem.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [sys/mod](../index.md) / IModUnionItem
-
-# Interface: IModUnionItem
-
-Defined in: [sys/mod.ts:1766](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1766)
-
-## Properties
-
-### field
-
-> **field**: `string`
-
-Defined in: [sys/mod.ts:1767](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1767)
-
-***
-
-### where?
-
-> `optional` **where**: `any`
-
-Defined in: [sys/mod.ts:1768](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1768)

package/doc/sc/api/sys/mod/interfaces/IRows.md

@@ -1,57 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [sys/mod](../index.md) / IRows
-
-# Interface: IRows\<T\>
-
-Defined in: [sys/mod.ts:1760](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1760)
-
-## Extends
-
-- `Iterable`\<`T`\>
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Properties
-
-### length
-
-> `readonly` **length**: `number`
-
-Defined in: [sys/mod.ts:1761](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1761)
-
-## Methods
-
-### item()
-
-> **item**(`index`): `T`
-
-Defined in: [sys/mod.ts:1762](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1762)
-
-#### Parameters
-
-##### index
-
-`number`
-
-#### Returns
-
-`T`
-
-***
-
-### toArray()
-
-> **toArray**(): `Record`\<`string`, `any`\>[]
-
-Defined in: [sys/mod.ts:1763](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1763)
-
-#### Returns
-
-`Record`\<`string`, `any`\>[]

package/doc/sc/api/sys/mod/type-aliases/TOnlyProperties.md

@@ -1,19 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [sys/mod](../index.md) / TOnlyProperties
-
-# Type Alias: TOnlyProperties\<T\>
-
-> **TOnlyProperties**\<`T`\> = `{ [K in keyof T as T[K] extends (args: any[]) => any ? never : K]: T[K] }`
-
-Defined in: [sys/mod.ts:14](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L14)
-
-只获取变量
-
-## Type Parameters
-
-### T
-
-`T`

package/doc/sc/api/sys/route/functions/clearKebabConfigs.md

@@ -1,17 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / clearKebabConfigs
-
-# Function: clearKebabConfigs()
-
-> **clearKebabConfigs**(): `void`
-
-Defined in: [sys/route.ts:30](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L30)
-
-清除已经加载的虚拟主机配置文件
-
-## Returns
-
-`void`

package/doc/sc/api/sys/route/functions/getFormData.md

@@ -1,47 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / getFormData
-
-# Function: getFormData()
-
-> **getFormData**(`req`, `events`): `Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>
-
-Defined in: [sys/route.ts:932](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L932)
-
-获取 formdata 的 post
-
-## Parameters
-
-### req
-
-请求头
-
-`IncomingMessage` | `Http2ServerRequest`
-
-### events
-
-文件处理情况
-
-#### onfiledata?
-
-(`chunk`) => `void`
-
-文件上传时触发，仅 start 返回 true 时触发
-
-#### onfileend?
-
-() => `void`
-
-文件上传结束时触发，仅 start 返回 true 时触发
-
-#### onfilestart?
-
-(`name`) => `boolean` \| `undefined`
-
-文件开始上传时触发，返回 true 则跳过该文件的保存
-
-## Returns
-
-`Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>

package/doc/sc/api/sys/route/functions/getPost.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / getPost
-
-# Function: getPost()
-
-> **getPost**(`req`): `Promise`\<\{ `input`: `string`; `post`: `Record`\<`string`, `any`\>; `raw`: `Record`\<`string`, `any`\>; \}\>
-
-Defined in: [sys/route.ts:866](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L866)
-
-获取 post 对象（通常已自动获取），如果是文件上传（formdata）的情况则不获取
-
-## Parameters
-
-### req
-
-请求对象
-
-`IncomingMessage` | `Http2ServerRequest`
-
-## Returns
-
-`Promise`\<\{ `input`: `string`; `post`: `Record`\<`string`, `any`\>; `raw`: `Record`\<`string`, `any`\>; \}\>

package/doc/sc/api/sys/route/functions/run.md

@@ -1,83 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / run
-
-# Function: run()
-
-> **run**(`data`): `Promise`\<`boolean`\>
-
-Defined in: [sys/route.ts:76](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L76)
-
-若为动态路径则执行此函数，此函数不进行判断 kebab.json 是否存在
-
-## Parameters
-
-### data
-
-传导的数据
-
-#### head?
-
-`Buffer`\<`ArrayBufferLike`\>
-
-WebSocket 的 head 数据
-
-#### path
-
-`string`
-
-前面不带 /，末尾不一定，以用户请求为准
-
-#### req
-
-`IncomingMessage` \| `Http2ServerRequest`
-
-#### res?
-
-`Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
-
-#### rootPath
-
-`string`
-
-虚拟主机当前动态目录的绝对根目录，末尾带 /
-
-#### socket?
-
-`Socket`
-
-WebSocket 连接的 socket 对象
-
-#### timer?
-
-\{ `callback`: () => `void`; `timeout`: `number`; `timer`: `Timeout`; \}
-
-timeout timer
-
-#### timer.callback
-
-() => `void`
-
-#### timer.timeout
-
-`number`
-
-#### timer.timer
-
-`Timeout`
-
-#### uri
-
-[`IUrlParse`](../../../index/interfaces/IUrlParse.md)
-
-#### urlBase
-
-`string`
-
-base url，如 /abc/vhost/，前后都带 /
-
-## Returns
-
-`Promise`\<`boolean`\>

package/doc/sc/api/sys/route/functions/unlinkUploadFiles.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / unlinkUploadFiles
-
-# Function: unlinkUploadFiles()
-
-> **unlinkUploadFiles**(`cctr`): `Promise`\<`void`\>
-
-Defined in: [sys/route.ts:825](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L825)
-
-删除本次请求所有已上传的临时文件
-
-## Parameters
-
-### cctr
-
-Ctr 对象 或 files
-
-[`Ctr`](../../ctr/classes/Ctr.md) | `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>
-
-## Returns
-
-`Promise`\<`void`\>

package/doc/sc/api/sys/route/functions/waitCtr.md

@@ -1,26 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [sys/route](../index.md) / waitCtr
-
-# Function: waitCtr()
-
-> **waitCtr**(`cctr`): `Promise`\<`void`\>
-
-Defined in: [sys/route.ts:845](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L845)
-
-等待异步任务结束，并删除临时文件，如果结束后还有事务没关闭，则会在本函数中打印控制台并且写入 log 文件
-此时其实已经给客户端返回了，此处等待不消耗客户端的等待时间
-
-## Parameters
-
-### cctr
-
-[`Ctr`](../../ctr/classes/Ctr.md)
-
-要等待的控制器
-
-## Returns
-
-`Promise`\<`void`\>

package/doc/sc/api/sys/route/index.md

@@ -1,16 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../index.md) / sys/route
-
-# sys/route
-
-## Functions
-
-- [clearKebabConfigs](functions/clearKebabConfigs.md)
-- [getFormData](functions/getFormData.md)
-- [getPost](functions/getPost.md)
-- [run](functions/run.md)
-- [unlinkUploadFiles](functions/unlinkUploadFiles.md)
-- [waitCtr](functions/waitCtr.md)

package/doc/sc/quick-start.md

@@ -1,30 +0,0 @@
-# 快速开始
-
-## 安装
-
-执行 `npm i @maiyunnet/kebab` 安装最新版，安装后，执行 `npx kebab init` 进行初始化，然后执行 `npx kebab` 启动项目。
-
-也可以使用 pm2 启动项目，执行 `pm2 start npx --name "kebab" -- kebab` 即可。
-
-## 目录
-
-项目初始化后，会生成一些基础文件和目录，介绍如下：
-
-- `conf/`: 配置
-  - `cert/`: 证书
-  - `vhost/`: 虚拟主机配置
-  - `cert.json`: 框架自动引入的证书配置
-  - `config.json`: 框架的所有配置内容（如 db、kv 等连接信息也在本文件）
-- `ftmp/`: 上传文件的临时存放
-- `ind/`: 独立应用，可用 npx kebab --ind xxx 启动
-- `lib/`: 用户编写的库
-- `log/`: 日志
-- `mod/`: 用户定义的模型
-- `www/`: 网站根目录
-  - `站点名或网址` - 例如 example.com、example，可多层
-    - `ctr/`: 控制器目录
-    - `data/`: 数据目录，存放语言文件等
-      - `locale/`: 语言文件目录
-    - `stc/`: 静态资源目录
-    - `view/`: 视图目录，存放 ejs 文件
-    - `ws/`: WebSocket 目录