@maiyunnet/kebab 7.6.1 → 7.6.2

package/doc/sc/api/lib/core/interfaces/ICookieOptions.md

@@ -1,59 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / ICookieOptions
-
-# Interface: ICookieOptions
-
-Defined in: [lib/core.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L34)
-
-Cookie 设置的选项
-
-## Properties
-
-### domain?
-
-> `optional` **domain**: `string`
-
-Defined in: [lib/core.ts:37](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L37)
-
-***
-
-### httponly?
-
-> `optional` **httponly**: `boolean`
-
-Defined in: [lib/core.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L39)
-
-***
-
-### path?
-
-> `optional` **path**: `string`
-
-Defined in: [lib/core.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L36)
-
-***
-
-### samesite?
-
-> `optional` **samesite**: `"Strict"` \| `"Lax"` \| `"None"`
-
-Defined in: [lib/core.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L40)
-
-***
-
-### ssl?
-
-> `optional` **ssl**: `boolean`
-
-Defined in: [lib/core.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L38)
-
-***
-
-### ttl?
-
-> `optional` **ttl**: `number`
-
-Defined in: [lib/core.ts:35](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L35)

package/doc/sc/api/lib/core/interfaces/ILogOptions.md

@@ -1,75 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / ILogOptions
-
-# Interface: ILogOptions
-
-Defined in: [lib/core.ts:756](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L756)
-
-log 设置的选项
-
-## Properties
-
-### cookie?
-
-> `optional` **cookie**: `Record`\<`string`, `string`\>
-
-Defined in: [lib/core.ts:762](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L762)
-
-***
-
-### get?
-
-> `optional` **get**: `Record`\<`string`, `any`\>
-
-Defined in: [lib/core.ts:761](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L761)
-
-***
-
-### headers?
-
-> `optional` **headers**: `IncomingHttpHeaders`
-
-Defined in: [lib/core.ts:764](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L764)
-
-***
-
-### hostname?
-
-> `optional` **hostname**: `string`
-
-Defined in: [lib/core.ts:759](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L759)
-
-***
-
-### path?
-
-> `optional` **path**: `string`
-
-Defined in: [lib/core.ts:757](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L757)
-
-***
-
-### req?
-
-> `optional` **req**: `IncomingMessage` \| `Http2ServerRequest` \| `null`
-
-Defined in: [lib/core.ts:760](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L760)
-
-***
-
-### session?
-
-> `optional` **session**: `Record`\<`string`, `any`\>
-
-Defined in: [lib/core.ts:763](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L763)
-
-***
-
-### urlFull?
-
-> `optional` **urlFull**: `string`
-
-Defined in: [lib/core.ts:758](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L758)

package/doc/sc/api/lib/core/type-aliases/TPm2Action.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / TPm2Action
-
-# Type Alias: TPm2Action
-
-> **TPm2Action** = `"start"` \| `"stop"` \| `"restart"`
-
-Defined in: [lib/core.ts:564](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L564)
-
-PM2 操作类型

package/doc/sc/api/lib/core/variables/RANDOM_L.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / RANDOM\_L
-
-# Variable: RANDOM\_L
-
-> `const` **RANDOM\_L**: `"abcdefghijklmnopqrstuvwxyz"` = `'abcdefghijklmnopqrstuvwxyz'`
-
-Defined in: [lib/core.ts:95](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L95)
-
-小写字母字符集

package/doc/sc/api/lib/core/variables/RANDOM_LN.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / RANDOM\_LN
-
-# Variable: RANDOM\_LN
-
-> `const` **RANDOM\_LN**: `string`
-
-Defined in: [lib/core.ts:100](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L100)
-
-小写字母 + 数字字符集

package/doc/sc/api/lib/core/variables/RANDOM_LU.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / RANDOM\_LU
-
-# Variable: RANDOM\_LU
-
-> `const` **RANDOM\_LU**: `string`
-
-Defined in: [lib/core.ts:102](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L102)
-
-小写字母 + 大写字母字符集

package/doc/sc/api/lib/core/variables/RANDOM_LUN.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / RANDOM\_LUN
-
-# Variable: RANDOM\_LUN
-
-> `const` **RANDOM\_LUN**: `string`
-
-Defined in: [lib/core.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L104)
-
-小写字母 + 大写字母 + 数字字符集

package/doc/sc/api/lib/core/variables/RANDOM_LUNS.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / RANDOM\_LUNS
-
-# Variable: RANDOM\_LUNS
-
-> `const` **RANDOM\_LUNS**: `string`
-
-Defined in: [lib/core.ts:108](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L108)
-
-小写字母 + 大写字母 + 数字字符集 + 特殊字符字符集

package/doc/sc/api/lib/core/variables/RANDOM_N.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / RANDOM\_N
-
-# Variable: RANDOM\_N
-
-> `const` **RANDOM\_N**: `"0123456789"` = `'0123456789'`
-
-Defined in: [lib/core.ts:91](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L91)
-
-数字字符集

package/doc/sc/api/lib/core/variables/RANDOM_U.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / RANDOM\_U
-
-# Variable: RANDOM\_U
-
-> `const` **RANDOM\_U**: `"ABCDEFGHIJKLMNOPQRSTUVWXYZ"` = `'ABCDEFGHIJKLMNOPQRSTUVWXYZ'`
-
-Defined in: [lib/core.ts:93](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L93)
-
-大写字母字符集

package/doc/sc/api/lib/core/variables/RANDOM_UN.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / RANDOM\_UN
-
-# Variable: RANDOM\_UN
-
-> `const` **RANDOM\_UN**: `string`
-
-Defined in: [lib/core.ts:98](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L98)
-
-大写字母 + 数字字符集

package/doc/sc/api/lib/core/variables/RANDOM_V.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / RANDOM\_V
-
-# Variable: RANDOM\_V
-
-> `const` **RANDOM\_V**: `"ACEFGHJKLMNPRSTWXY34567"` = `'ACEFGHJKLMNPRSTWXY34567'`
-
-Defined in: [lib/core.ts:106](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L106)
-
-验证码字符集

package/doc/sc/api/lib/core/variables/REAL_IP_CF.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / REAL\_IP\_CF
-
-# Variable: REAL\_IP\_CF
-
-> `const` **REAL\_IP\_CF**: `"cf-connecting-ip"` = `'cf-connecting-ip'`
-
-Defined in: [lib/core.ts:355](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L355)
-
-使用的是 Cloudflare

package/doc/sc/api/lib/core/variables/REAL_IP_X.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / REAL\_IP\_X
-
-# Variable: REAL\_IP\_X
-
-> `const` **REAL\_IP\_X**: `"x-forwarded-for"` = `'x-forwarded-for'`
-
-Defined in: [lib/core.ts:353](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L353)
-
-使用 X-Forwarded-For 的 CDN 厂商

package/doc/sc/api/lib/core/variables/global.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / global
-
-# Variable: global
-
-> `const` **global**: `Record`\<`string`, `any`\> = `{}`
-
-Defined in: [lib/core.ts:647](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L647)
-
-跨进程全局变量

package/doc/sc/api/lib/core/variables/globalConfig.md

@@ -1,47 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / globalConfig
-
-# Variable: globalConfig
-
-> `const` **globalConfig**: [`IConfig`](../../../index/interfaces/IConfig.md) & `object`
-
-Defined in: [lib/core.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L22)
-
-全局参数
-
-## Type Declaration
-
-### debug
-
-> **debug**: `boolean`
-
-### hosts
-
-> **hosts**: `string`[]
-
-### httpPort
-
-> **httpPort**: `number`
-
-### httpsPort
-
-> **httpsPort**: `number`
-
-### ind
-
-> **ind**: `string`[]
-
-### max
-
-> **max**: `number`
-
-### rpcPort
-
-> **rpcPort**: `number`
-
-### rpcSecret
-
-> **rpcSecret**: `string`

package/doc/sc/api/lib/cron/functions/getRegulars.md

@@ -1,17 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/cron](../index.md) / getRegulars
-
-# Function: getRegulars()
-
-> **getRegulars**(): [`IRegularData`](../interfaces/IRegularData.md)[]
-
-Defined in: [lib/cron.ts:17](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L17)
-
-获取定时任务列表
-
-## Returns
-
-[`IRegularData`](../interfaces/IRegularData.md)[]

package/doc/sc/api/lib/cron/functions/regular.md

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/cron](../index.md) / regular
-
-# Function: regular()
-
-> **regular**(`task`, `immediate`): `Promise`\<`boolean`\>
-
-Defined in: [lib/cron.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L26)
-
-创建定时执行的计划任务
-
-## Parameters
-
-### task
-
-[`IRegular`](../interfaces/IRegular.md)
-
-计划任务对象
-
-### immediate
-
-`string` = `''`
-
-如果传入的时间小于当前时间且[没有执行过]则立即执行一次（格式：YmdHi，系统时区）
-
-## Returns
-
-`Promise`\<`boolean`\>

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

@@ -1,17 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../index.md) / lib/cron
-
-# lib/cron
-
-## Interfaces
-
-- [IRegular](interfaces/IRegular.md)
-- [IRegularData](interfaces/IRegularData.md)
-
-## Functions
-
-- [getRegulars](functions/getRegulars.md)
-- [regular](functions/regular.md)

package/doc/sc/api/lib/cron/interfaces/IRegular.md

@@ -1,59 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/cron](../index.md) / IRegular
-
-# Interface: IRegular
-
-Defined in: [lib/cron.ts:93](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L93)
-
-定时任务
-
-## Extended by
-
-- [`IRegularData`](IRegularData.md)
-
-## Properties
-
-### callback()
-
-> **callback**: (`date`, `immediate`) => `void` \| `Promise`\<`void`\>
-
-Defined in: [lib/cron.ts:99](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L99)
-
-任务函数
-
-#### Parameters
-
-##### date
-
-`string`
-
-##### immediate
-
-`boolean`
-
-#### Returns
-
-`void` \| `Promise`\<`void`\>
-
-***
-
-### name
-
-> **name**: `string`
-
-Defined in: [lib/cron.ts:95](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L95)
-
-任务名称，只能小写字母、数字、短横线、下划线，长度 1-32
-
-***
-
-### rule
-
-> **rule**: `string`
-
-Defined in: [lib/cron.ts:97](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L97)
-
-规则，分、时、日、月、星期，与 linux 的 cron 相同（不支持秒）

package/doc/sc/api/lib/cron/interfaces/IRegularData.md

@@ -1,101 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/cron](../index.md) / IRegularData
-
-# Interface: IRegularData
-
-Defined in: [lib/cron.ts:102](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L102)
-
-定时任务
-
-## Extends
-
-- [`IRegular`](IRegular.md)
-
-## Properties
-
-### callback()
-
-> **callback**: (`date`, `immediate`) => `void` \| `Promise`\<`void`\>
-
-Defined in: [lib/cron.ts:99](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L99)
-
-任务函数
-
-#### Parameters
-
-##### date
-
-`string`
-
-##### immediate
-
-`boolean`
-
-#### Returns
-
-`void` \| `Promise`\<`void`\>
-
-#### Inherited from
-
-[`IRegular`](IRegular.md).[`callback`](IRegular.md#callback)
-
-***
-
-### count
-
-> **count**: `number`
-
-Defined in: [lib/cron.ts:106](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L106)
-
-总执行次数
-
-***
-
-### last
-
-> **last**: `string`
-
-Defined in: [lib/cron.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L104)
-
-上次执行时间字符串，格式：YmdHi（系统时区）
-
-***
-
-### name
-
-> **name**: `string`
-
-Defined in: [lib/cron.ts:95](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L95)
-
-任务名称，只能小写字母、数字、短横线、下划线，长度 1-32
-
-#### Inherited from
-
-[`IRegular`](IRegular.md).[`name`](IRegular.md#name)
-
-***
-
-### rcount
-
-> **rcount**: `number`
-
-Defined in: [lib/cron.ts:108](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L108)
-
-定时任务重启后的执行次数
-
-***
-
-### rule
-
-> **rule**: `string`
-
-Defined in: [lib/cron.ts:97](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L97)
-
-规则，分、时、日、月、星期，与 linux 的 cron 相同（不支持秒）
-
-#### Inherited from
-
-[`IRegular`](IRegular.md).[`rule`](IRegular.md#rule)

package/doc/sc/api/lib/crypto/functions/aesDecrypt.md

@@ -1,91 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / aesDecrypt
-
-# Function: aesDecrypt()
-
-## Call Signature
-
-> **aesDecrypt**(`encrypt`, `key`, `iv`, `method`, `output`): `false` \| `Buffer`\<`ArrayBufferLike`\>
-
-Defined in: [lib/crypto.ts:339](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L339)
-
-AES 解密
-
-### Parameters
-
-#### encrypt
-
-需解密的字符串
-
-`string` | `Buffer`\<`ArrayBufferLike`\>
-
-#### key
-
-`CipherKey`
-
-密钥 32 个英文字母和数字
-
-#### iv
-
-`string`
-
-向量 16(CTR) 或 12(GCM) 个英文字母和数字
-
-#### method
-
-`string`
-
-加密方法
-
-#### output
-
-`"buffer"`
-
-### Returns
-
-`false` \| `Buffer`\<`ArrayBufferLike`\>
-
-## Call Signature
-
-> **aesDecrypt**(`encrypt`, `key`, `iv?`, `method?`, `output?`): `string` \| `false`
-
-Defined in: [lib/crypto.ts:340](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L340)
-
-AES 解密
-
-### Parameters
-
-#### encrypt
-
-需解密的字符串
-
-`string` | `Buffer`\<`ArrayBufferLike`\>
-
-#### key
-
-`CipherKey`
-
-密钥 32 个英文字母和数字
-
-#### iv?
-
-`string`
-
-向量 16(CTR) 或 12(GCM) 个英文字母和数字
-
-#### method?
-
-`string`
-
-加密方法
-
-#### output?
-
-`"binary"`
-
-### Returns
-
-`string` \| `false`