@maiyunnet/kebab 7.5.0 → 7.6.1

package/doc/sc/api/lib/core/functions/sleep.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / sleep
+
+# Function: sleep()
+
+> **sleep**(`ms`): `Promise`\<`void`\>
+
+Defined in: [lib/core.ts:378](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L378)
+
+间隔一段时间
+
+## Parameters
+
+### ms
+
+`number`
+
+间隔毫秒
+
+## Returns
+
+`Promise`\<`void`\>

package/doc/sc/api/lib/core/functions/unconvert62.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / unconvert62
+
+# Function: unconvert62()
+
+> **unconvert62**(`n`): `bigint`
+
+Defined in: [lib/core.ts:157](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L157)
+
+将 62 进制转换为 10 进制
+
+## Parameters
+
+### n
+
+`string`
+
+62 进制数字最大 aZl8N0y58M7
+
+## Returns
+
+`bigint`

package/doc/sc/api/lib/core/functions/updateCode.md

@@ -0,0 +1,49 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / updateCode
+
+# Function: updateCode()
+
+> **updateCode**(`sourcePath`, `path`, `hosts?`, `config?`, `strict?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
+
+Defined in: [lib/core.ts:708](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L708)
+
+上传并覆盖代码文件，config.json、kebab.json、.js.map、.ts, .gitignore 不会被覆盖和新创建
+
+## Parameters
+
+### sourcePath
+
+`string`
+
+zip 文件
+
+### path
+
+`string`
+
+要更新的目标路径，无所谓是否 / 开头 / 结尾，是对方 kebab 的根据路径开始算起
+
+### hosts?
+
+局域网多机部署，不设置默认本机部署
+
+`string`[] | `"config"`
+
+### config?
+
+`boolean` = `true`
+
+是否自动更新 config 的 set.staticVer 为最新，默认更新
+
+### strict?
+
+`boolean` = `true`
+
+严格模式，只有存在的文件才会被覆盖，不存在则中途直接报错，默认为 true
+
+## Returns
+
+`Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>

package/doc/sc/api/lib/core/functions/write.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / write
+
+# Function: write()
+
+> **write**(`res`, `data`): `void`
+
+Defined in: [lib/core.ts:1025](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1025)
+
+向 res 发送数据
+
+## Parameters
+
+### res
+
+响应对象
+
+`Socket` | `Http2ServerResponse`\<`Http2ServerRequest`\> | `ServerResponse`\<`IncomingMessage`\>
+
+### data
+
+数据
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+## Returns
+
+`void`

package/doc/sc/api/lib/core/functions/writeEventStreamHead.md

@@ -0,0 +1,21 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / writeEventStreamHead
+
+# Function: writeEventStreamHead()
+
+> **writeEventStreamHead**(`res`): `void`
+
+Defined in: [lib/core.ts:1013](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1013)
+
+## Parameters
+
+### res
+
+`Http2ServerResponse`\<`Http2ServerRequest`\> | `ServerResponse`\<`IncomingMessage`\>
+
+## Returns
+
+`void`

package/doc/sc/api/lib/core/functions/writeHead.md

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / writeHead
+
+# Function: writeHead()
+
+> **writeHead**(`res`, `statusCode`, `headers?`): `void`
+
+Defined in: [lib/core.ts:1002](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1002)
+
+让 res 发送头部（前提是头部没有被发送才能调用本方法
+
+## Parameters
+
+### res
+
+响应对象
+
+`Http2ServerResponse`\<`Http2ServerRequest`\> | `ServerResponse`\<`IncomingMessage`\>
+
+### statusCode
+
+`number`
+
+状态码
+
+### headers?
+
+`OutgoingHttpHeaders`
+
+头部
+
+## Returns
+
+`void`

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

@@ -0,0 +1,66 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/core
+
+# lib/core
+
+## Interfaces
+
+- [ICookieOptions](interfaces/ICookieOptions.md)
+- [ILogOptions](interfaces/ILogOptions.md)
+
+## Type Aliases
+
+- [TPm2Action](type-aliases/TPm2Action.md)
+
+## Variables
+
+- [global](variables/global.md)
+- [globalConfig](variables/globalConfig.md)
+- [RANDOM\_L](variables/RANDOM_L.md)
+- [RANDOM\_LN](variables/RANDOM_LN.md)
+- [RANDOM\_LU](variables/RANDOM_LU.md)
+- [RANDOM\_LUN](variables/RANDOM_LUN.md)
+- [RANDOM\_LUNS](variables/RANDOM_LUNS.md)
+- [RANDOM\_N](variables/RANDOM_N.md)
+- [RANDOM\_U](variables/RANDOM_U.md)
+- [RANDOM\_UN](variables/RANDOM_UN.md)
+- [RANDOM\_V](variables/RANDOM_V.md)
+- [REAL\_IP\_CF](variables/REAL_IP_CF.md)
+- [REAL\_IP\_X](variables/REAL_IP_X.md)
+
+## Functions
+
+- [checkType](functions/checkType.md)
+- [clone](functions/clone.md)
+- [convert62](functions/convert62.md)
+- [debug](functions/debug.md)
+- [display](functions/display.md)
+- [emptyObject](functions/emptyObject.md)
+- [exec](functions/exec.md)
+- [getLog](functions/getLog.md)
+- [ip](functions/ip.md)
+- [log](functions/log.md)
+- [ls](functions/ls.md)
+- [muid](functions/muid.md)
+- [objectSort](functions/objectSort.md)
+- [passThroughAppend](functions/passThroughAppend.md)
+- [purify](functions/purify.md)
+- [rand](functions/rand.md)
+- [random](functions/random.md)
+- [realIP](functions/realIP.md)
+- [removeGlobal](functions/removeGlobal.md)
+- [sendNpm](functions/sendNpm.md)
+- [sendPm2](functions/sendPm2.md)
+- [sendReload](functions/sendReload.md)
+- [sendRestart](functions/sendRestart.md)
+- [setCookie](functions/setCookie.md)
+- [setGlobal](functions/setGlobal.md)
+- [sleep](functions/sleep.md)
+- [unconvert62](functions/unconvert62.md)
+- [updateCode](functions/updateCode.md)
+- [write](functions/write.md)
+- [writeEventStreamHead](functions/writeEventStreamHead.md)
+- [writeHead](functions/writeHead.md)

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

@@ -0,0 +1,59 @@
+[**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

@@ -0,0 +1,75 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,13 @@
+[**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

@@ -0,0 +1,47 @@
+[**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

@@ -0,0 +1,17 @@
+[**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

@@ -0,0 +1,31 @@
+[**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`\>