@maiyunnet/kebab 7.5.0 → 7.6.1

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

@@ -0,0 +1,47 @@
+[**Documents for @maiyunnet/kebab**](../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../index.md) / index
+
+# index
+
+## Interfaces
+
+- [IConfig](interfaces/IConfig.md)
+- [IConfigAi](interfaces/IConfigAi.md)
+- [IConfigConst](interfaces/IConfigConst.md)
+- [IConfigDb](interfaces/IConfigDb.md)
+- [IConfigDns](interfaces/IConfigDns.md)
+- [IConfigJwt](interfaces/IConfigJwt.md)
+- [IConfigKv](interfaces/IConfigKv.md)
+- [IConfigLang](interfaces/IConfigLang.md)
+- [IConfigS3](interfaces/IConfigS3.md)
+- [IConfigSql](interfaces/IConfigSql.md)
+- [IConfigTurnstile](interfaces/IConfigTurnstile.md)
+- [IConfigVector](interfaces/IConfigVector.md)
+- [IPostFile](interfaces/IPostFile.md)
+- [IUrlParse](interfaces/IUrlParse.md)
+- [IVhost](interfaces/IVhost.md)
+
+## Type Aliases
+
+- [DbValue](type-aliases/DbValue.md)
+- [Json](type-aliases/Json.md)
+
+## Variables
+
+- [CERT\_CWD](variables/CERT_CWD.md)
+- [CONF\_CWD](variables/CONF_CWD.md)
+- [FTMP\_CWD](variables/FTMP_CWD.md)
+- [IND\_CWD](variables/IND_CWD.md)
+- [LIB\_CWD](variables/LIB_CWD.md)
+- [LIB\_PATH](variables/LIB_PATH.md)
+- [LOG\_CWD](variables/LOG_CWD.md)
+- [MOD\_CWD](variables/MOD_CWD.md)
+- [ROOT\_CWD](variables/ROOT_CWD.md)
+- [ROOT\_PATH](variables/ROOT_PATH.md)
+- [SYS\_PATH](variables/SYS_PATH.md)
+- [VER](variables/VER.md)
+- [VHOST\_CWD](variables/VHOST_CWD.md)
+- [WWW\_CWD](variables/WWW_CWD.md)

package/doc/sc/api/index/interfaces/IConfig.md

@@ -0,0 +1,165 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / [index](../index.md) / IConfig
+
+# Interface: IConfig
+
+Defined in: [index.ts:50](https://github.com/maiyunnet/kebab/blob/master/index.ts#L50)
+
+目录配置文件
+
+## Indexable
+
+\[`key`: `string`\]: `Record`\<`string`, `any`\>
+
+## Properties
+
+### ai
+
+> **ai**: `Record`\<`string`, [`IConfigAi`](IConfigAi.md)\>
+
+Defined in: [index.ts:81](https://github.com/maiyunnet/kebab/blob/master/index.ts#L81)
+
+***
+
+### const
+
+> **const**: [`IConfigConst`](IConfigConst.md)
+
+Defined in: [index.ts:62](https://github.com/maiyunnet/kebab/blob/master/index.ts#L62)
+
+***
+
+### db
+
+> **db**: `Record`\<`string`, \{ `default`: [`IConfigDb`](IConfigDb.md); `read`: [`IConfigDb`](IConfigDb.md); \}\> & `object`
+
+Defined in: [index.ts:63](https://github.com/maiyunnet/kebab/blob/master/index.ts#L63)
+
+#### Type Declaration
+
+##### default
+
+> **default**: `"MYSQL"` \| `"PGSQL"`
+
+***
+
+### dns
+
+> **dns**: `Record`\<`string`, [`IConfigDns`](IConfigDns.md)\>
+
+Defined in: [index.ts:77](https://github.com/maiyunnet/kebab/blob/master/index.ts#L77)
+
+***
+
+### kv
+
+> **kv**: [`IConfigKv`](IConfigKv.md)
+
+Defined in: [index.ts:69](https://github.com/maiyunnet/kebab/blob/master/index.ts#L69)
+
+***
+
+### lang
+
+> **lang**: [`IConfigLang`](IConfigLang.md)
+
+Defined in: [index.ts:78](https://github.com/maiyunnet/kebab/blob/master/index.ts#L78)
+
+***
+
+### route
+
+> **route**: `Record`\<`string`, `string`\>
+
+Defined in: [index.ts:70](https://github.com/maiyunnet/kebab/blob/master/index.ts#L70)
+
+***
+
+### s3
+
+> **s3**: `Record`\<`string`, [`IConfigS3`](IConfigS3.md)\>
+
+Defined in: [index.ts:79](https://github.com/maiyunnet/kebab/blob/master/index.ts#L79)
+
+***
+
+### session
+
+> **session**: `object`
+
+Defined in: [index.ts:71](https://github.com/maiyunnet/kebab/blob/master/index.ts#L71)
+
+#### name
+
+> **name**: `string`
+
+#### ssl
+
+> **ssl**: `boolean`
+
+#### ttl
+
+> **ttl**: `number`
+
+***
+
+### set
+
+> **set**: `object`
+
+Defined in: [index.ts:51](https://github.com/maiyunnet/kebab/blob/master/index.ts#L51)
+
+#### Index Signature
+
+\[`key`: `string`\]: `any`
+
+#### cacheTtl
+
+> **cacheTtl**: `number`
+
+#### mustHttps
+
+> **mustHttps**: `boolean`
+
+#### staticPath
+
+> **staticPath**: `string`
+
+#### staticPathFull
+
+> **staticPathFull**: `string`
+
+#### staticVer
+
+> **staticVer**: `string`
+
+#### timezone
+
+> **timezone**: `number`
+
+***
+
+### sql
+
+> **sql**: [`IConfigSql`](IConfigSql.md)
+
+Defined in: [index.ts:76](https://github.com/maiyunnet/kebab/blob/master/index.ts#L76)
+
+***
+
+### turnstile
+
+> **turnstile**: [`IConfigTurnstile`](IConfigTurnstile.md)
+
+Defined in: [index.ts:80](https://github.com/maiyunnet/kebab/blob/master/index.ts#L80)
+
+***
+
+### vector
+
+> **vector**: [`IConfigVector`](IConfigVector.md)
+
+Defined in: [index.ts:82](https://github.com/maiyunnet/kebab/blob/master/index.ts#L82)

package/doc/sc/api/index/interfaces/IConfigAi.md

@@ -0,0 +1,29 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / [index](../index.md) / IConfigAi
+
+# Interface: IConfigAi
+
+Defined in: [index.ts:118](https://github.com/maiyunnet/kebab/blob/master/index.ts#L118)
+
+AI
+
+## Properties
+
+### endpoint?
+
+> `optional` **endpoint**: `string`
+
+Defined in: [index.ts:120](https://github.com/maiyunnet/kebab/blob/master/index.ts#L120)
+
+目前只有微软 Azure 有
+
+***
+
+### skey
+
+> **skey**: `string`
+
+Defined in: [index.ts:121](https://github.com/maiyunnet/kebab/blob/master/index.ts#L121)

package/doc/sc/api/index/interfaces/IConfigConst.md

@@ -0,0 +1,201 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / [index](../index.md) / IConfigConst
+
+# Interface: IConfigConst
+
+Defined in: [index.ts:190](https://github.com/maiyunnet/kebab/blob/master/index.ts#L190)
+
+常量
+
+## Properties
+
+### ctrPath
+
+> **ctrPath**: `string`
+
+Defined in: [index.ts:215](https://github.com/maiyunnet/kebab/blob/master/index.ts#L215)
+
+***
+
+### dataPath
+
+> **dataPath**: `string`
+
+Defined in: [index.ts:217](https://github.com/maiyunnet/kebab/blob/master/index.ts#L217)
+
+***
+
+### host
+
+> **host**: `string`
+
+Defined in: [index.ts:206](https://github.com/maiyunnet/kebab/blob/master/index.ts#L206)
+
+***
+
+### hostname
+
+> **hostname**: `string`
+
+Defined in: [index.ts:207](https://github.com/maiyunnet/kebab/blob/master/index.ts#L207)
+
+***
+
+### hostport
+
+> **hostport**: `number`
+
+Defined in: [index.ts:208](https://github.com/maiyunnet/kebab/blob/master/index.ts#L208)
+
+***
+
+### https
+
+> **https**: `boolean`
+
+Defined in: [index.ts:205](https://github.com/maiyunnet/kebab/blob/master/index.ts#L205)
+
+***
+
+### miniprogram
+
+> **miniprogram**: `""` \| `"wechat"`
+
+Defined in: [index.ts:204](https://github.com/maiyunnet/kebab/blob/master/index.ts#L204)
+
+***
+
+### mobile
+
+> **mobile**: `boolean`
+
+Defined in: [index.ts:202](https://github.com/maiyunnet/kebab/blob/master/index.ts#L202)
+
+***
+
+### modPath
+
+> **modPath**: `string`
+
+Defined in: [index.ts:214](https://github.com/maiyunnet/kebab/blob/master/index.ts#L214)
+
+***
+
+### path
+
+> **path**: `string`
+
+Defined in: [index.ts:192](https://github.com/maiyunnet/kebab/blob/master/index.ts#L192)
+
+不以 / 开头，不含 qs
+
+***
+
+### qs
+
+> **qs**: `string`
+
+Defined in: [index.ts:194](https://github.com/maiyunnet/kebab/blob/master/index.ts#L194)
+
+不含 ? 开头
+
+***
+
+### qss
+
+> **qss**: `string`
+
+Defined in: [index.ts:196](https://github.com/maiyunnet/kebab/blob/master/index.ts#L196)
+
+含 ? 开头
+
+***
+
+### rootPath
+
+> **rootPath**: `string`
+
+Defined in: [index.ts:213](https://github.com/maiyunnet/kebab/blob/master/index.ts#L213)
+
+***
+
+### startMemory
+
+> **startMemory**: `number`
+
+Defined in: [index.ts:198](https://github.com/maiyunnet/kebab/blob/master/index.ts#L198)
+
+***
+
+### startTime
+
+> **startTime**: `bigint`
+
+Defined in: [index.ts:197](https://github.com/maiyunnet/kebab/blob/master/index.ts#L197)
+
+***
+
+### uri
+
+> **uri**: [`IUrlParse`](IUrlParse.md)
+
+Defined in: [index.ts:209](https://github.com/maiyunnet/kebab/blob/master/index.ts#L209)
+
+***
+
+### urlBase
+
+> **urlBase**: `string`
+
+Defined in: [index.ts:222](https://github.com/maiyunnet/kebab/blob/master/index.ts#L222)
+
+***
+
+### urlFull
+
+> **urlFull**: `string`
+
+Defined in: [index.ts:224](https://github.com/maiyunnet/kebab/blob/master/index.ts#L224)
+
+***
+
+### urlStc
+
+> **urlStc**: `string`
+
+Defined in: [index.ts:223](https://github.com/maiyunnet/kebab/blob/master/index.ts#L223)
+
+***
+
+### urlStcFull
+
+> **urlStcFull**: `string`
+
+Defined in: [index.ts:225](https://github.com/maiyunnet/kebab/blob/master/index.ts#L225)
+
+***
+
+### viewPath
+
+> **viewPath**: `string`
+
+Defined in: [index.ts:216](https://github.com/maiyunnet/kebab/blob/master/index.ts#L216)
+
+***
+
+### wechat
+
+> **wechat**: `boolean`
+
+Defined in: [index.ts:203](https://github.com/maiyunnet/kebab/blob/master/index.ts#L203)
+
+***
+
+### wsPath
+
+> **wsPath**: `string`
+
+Defined in: [index.ts:218](https://github.com/maiyunnet/kebab/blob/master/index.ts#L218)

package/doc/sc/api/index/interfaces/IConfigDb.md

@@ -0,0 +1,59 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / [index](../index.md) / IConfigDb
+
+# Interface: IConfigDb
+
+Defined in: [index.ts:148](https://github.com/maiyunnet/kebab/blob/master/index.ts#L148)
+
+数据库
+
+## Properties
+
+### charset
+
+> **charset**: `string`
+
+Defined in: [index.ts:151](https://github.com/maiyunnet/kebab/blob/master/index.ts#L151)
+
+***
+
+### host
+
+> **host**: `string`
+
+Defined in: [index.ts:149](https://github.com/maiyunnet/kebab/blob/master/index.ts#L149)
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [index.ts:152](https://github.com/maiyunnet/kebab/blob/master/index.ts#L152)
+
+***
+
+### port
+
+> **port**: `number`
+
+Defined in: [index.ts:150](https://github.com/maiyunnet/kebab/blob/master/index.ts#L150)
+
+***
+
+### pwd
+
+> **pwd**: `string`
+
+Defined in: [index.ts:155](https://github.com/maiyunnet/kebab/blob/master/index.ts#L155)
+
+***
+
+### user
+
+> **user**: `string`
+
+Defined in: [index.ts:154](https://github.com/maiyunnet/kebab/blob/master/index.ts#L154)

package/doc/sc/api/index/interfaces/IConfigDns.md

@@ -0,0 +1,27 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / [index](../index.md) / IConfigDns
+
+# Interface: IConfigDns
+
+Defined in: [index.ts:168](https://github.com/maiyunnet/kebab/blob/master/index.ts#L168)
+
+DNS
+
+## Properties
+
+### sid
+
+> **sid**: `string`
+
+Defined in: [index.ts:169](https://github.com/maiyunnet/kebab/blob/master/index.ts#L169)
+
+***
+
+### skey
+
+> **skey**: `string`
+
+Defined in: [index.ts:170](https://github.com/maiyunnet/kebab/blob/master/index.ts#L170)

package/doc/sc/api/index/interfaces/IConfigJwt.md

@@ -0,0 +1,51 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / [index](../index.md) / IConfigJwt
+
+# Interface: IConfigJwt
+
+Defined in: [index.ts:159](https://github.com/maiyunnet/kebab/blob/master/index.ts#L159)
+
+Jwt 信息
+
+## Properties
+
+### auth
+
+> **auth**: `boolean`
+
+Defined in: [index.ts:164](https://github.com/maiyunnet/kebab/blob/master/index.ts#L164)
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [index.ts:160](https://github.com/maiyunnet/kebab/blob/master/index.ts#L160)
+
+***
+
+### secret
+
+> **secret**: `string`
+
+Defined in: [index.ts:163](https://github.com/maiyunnet/kebab/blob/master/index.ts#L163)
+
+***
+
+### ssl
+
+> **ssl**: `boolean`
+
+Defined in: [index.ts:162](https://github.com/maiyunnet/kebab/blob/master/index.ts#L162)
+
+***
+
+### ttl
+
+> **ttl**: `number`
+
+Defined in: [index.ts:161](https://github.com/maiyunnet/kebab/blob/master/index.ts#L161)

package/doc/sc/api/index/interfaces/IConfigKv.md

@@ -0,0 +1,59 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / [index](../index.md) / IConfigKv
+
+# Interface: IConfigKv
+
+Defined in: [index.ts:174](https://github.com/maiyunnet/kebab/blob/master/index.ts#L174)
+
+kv
+
+## Properties
+
+### host
+
+> **host**: `string`
+
+Defined in: [index.ts:175](https://github.com/maiyunnet/kebab/blob/master/index.ts#L175)
+
+***
+
+### index
+
+> **index**: `number`
+
+Defined in: [index.ts:177](https://github.com/maiyunnet/kebab/blob/master/index.ts#L177)
+
+***
+
+### port
+
+> **port**: `number`
+
+Defined in: [index.ts:176](https://github.com/maiyunnet/kebab/blob/master/index.ts#L176)
+
+***
+
+### pre
+
+> **pre**: `string`
+
+Defined in: [index.ts:178](https://github.com/maiyunnet/kebab/blob/master/index.ts#L178)
+
+***
+
+### pwd
+
+> **pwd**: `string`
+
+Defined in: [index.ts:181](https://github.com/maiyunnet/kebab/blob/master/index.ts#L181)
+
+***
+
+### user
+
+> **user**: `string`
+
+Defined in: [index.ts:180](https://github.com/maiyunnet/kebab/blob/master/index.ts#L180)

package/doc/sc/api/index/interfaces/IConfigLang.md

@@ -0,0 +1,27 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / [index](../index.md) / IConfigLang
+
+# Interface: IConfigLang
+
+Defined in: [index.ts:102](https://github.com/maiyunnet/kebab/blob/master/index.ts#L102)
+
+语言
+
+## Properties
+
+### direct
+
+> **direct**: `string`[]
+
+Defined in: [index.ts:104](https://github.com/maiyunnet/kebab/blob/master/index.ts#L104)
+
+***
+
+### list
+
+> **list**: `string`[]
+
+Defined in: [index.ts:103](https://github.com/maiyunnet/kebab/blob/master/index.ts#L103)