@maiyunnet/kebab 7.6.1 → 7.6.3

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

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / passThroughAppend
-
-# Function: passThroughAppend()
-
-> **passThroughAppend**(`passThrough`, `data`, `end`): `Promise`\<`void`\>
-
-Defined in: [lib/core.ts:428](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L428)
-
-调用前自行创建 passThrough，并且调用 pipe 绑定到应该绑定的对象，然后再调用本函数
-
-## Parameters
-
-### passThrough
-
-`PassThrough`
-
-passThrough 对象
-
-### data
-
-(`string` \| `Buffer`\<`ArrayBufferLike`\> \| `Readable` \| [`Response`](../../net/response/classes/Response.md))[]
-
-数组
-
-### end
-
-`boolean` = `true`
-
-是否关闭写入，默认是，关闭后 passThrough 不能被写入，但仍然可读
-
-## Returns
-
-`Promise`\<`void`\>

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

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / purify
-
-# Function: purify()
-
-> **purify**(`text`): `string`
-
-Defined in: [lib/core.ts:170](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L170)
-
-去除 html 的空白符、换行以及注释
-
-## Parameters
-
-### text
-
-`string`
-
-要纯净的字符串
-
-## Returns
-
-`string`

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

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / rand
-
-# Function: rand()
-
-> **rand**(`min`, `max`, `prec`): `number`
-
-Defined in: [lib/core.ts:79](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L79)
-
-生成基础的范围随机数
-
-## Parameters
-
-### min
-
-`number`
-
->= 最小值
-
-### max
-
-`number`
-
-<= 最大值
-
-### prec
-
-`number` = `0`
-
-保留几位小数
-
-## Returns
-
-`number`

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

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / random
-
-# Function: random()
-
-> **random**(`length`, `source`, `block`): `string`
-
-Defined in: [lib/core.ts:116](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L116)
-
-生成随机字符串
-
-## Parameters
-
-### length
-
-`number` = `8`
-
-长度
-
-### source
-
-`string` = `RANDOM_LN`
-
-采样值
-
-### block
-
-`string` = `''`
-
-排除的字符
-
-## Returns
-
-`string`

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

@@ -1,29 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / realIP
-
-# Function: realIP()
-
-> **realIP**(`ctr`, `name`): `string`
-
-Defined in: [lib/core.ts:362](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L362)
-
-获取直连 IP（安全 IP）
-
-## Parameters
-
-### ctr
-
-[`Ctr`](../../../sys/ctr/classes/Ctr.md)
-
-### name
-
-`string` = `''`
-
-输入安全的 header
-
-## Returns
-
-`string`

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

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / removeGlobal
-
-# Function: removeGlobal()
-
-> **removeGlobal**(`key`, `hosts?`): `Promise`\<`string`[]\>
-
-Defined in: [lib/core.ts:696](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L696)
-
-移除某个跨线程/跨内网服务器全局变量
-
-## Parameters
-
-### key
-
-`string`
-
-变量名
-
-### hosts?
-
-`string`[]
-
-局域网列表
-
-## Returns
-
-`Promise`\<`string`[]\>

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

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / sendNpm
-
-# Function: sendNpm()
-
-> **sendNpm**(`path`, `hosts?`): `Promise`\<`string`[]\>
-
-Defined in: [lib/core.ts:612](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L612)
-
-向本机或局域网 RPC 发送 npm install 操作
-
-## Parameters
-
-### path
-
-`string`
-
-路径，如 /home/kebab/
-
-### hosts?
-
-局域网列表
-
-`string`[] | `"config"`
-
-## Returns
-
-`Promise`\<`string`[]\>

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

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / sendPm2
-
-# Function: sendPm2()
-
-> **sendPm2**(`name`, `action`, `hosts?`): `Promise`\<`string`[]\>
-
-Defined in: [lib/core.ts:572](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L572)
-
-向本机或局域网 RPC 发送 PM2 操作
-
-## Parameters
-
-### name
-
-`string`
-
-PM2 进程名称
-
-### action
-
-[`TPm2Action`](../type-aliases/TPm2Action.md) = `'restart'`
-
-PM2 操作类型
-
-### hosts?
-
-局域网列表
-
-`string`[] | `"config"`
-
-## Returns
-
-`Promise`\<`string`[]\>

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

@@ -1,24 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / sendReload
-
-# Function: sendReload()
-
-> **sendReload**(`hosts?`): `Promise`\<`string`[]\>
-
-Defined in: [lib/core.ts:487](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L487)
-
-向主进程（或局域网同代码机子）发送广播将进行 reload 操作，等待回传
-主要作用除代码热更新以外的其他情况
-
-## Parameters
-
-### hosts?
-
-`string`[] | `"config"`
-
-## Returns
-
-`Promise`\<`string`[]\>

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

@@ -1,24 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / sendRestart
-
-# Function: sendRestart()
-
-> **sendRestart**(`hosts?`): `Promise`\<`string`[]\>
-
-Defined in: [lib/core.ts:527](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L527)
-
-向主进程（或局域网同代码机子）发送广播将进行 restart 操作，停止监听并启动新进程，老进程在连接全部断开后自行销毁
-主要用作不间断的代码热更新
-
-## Parameters
-
-### hosts?
-
-`string`[] | `"config"`
-
-## Returns
-
-`Promise`\<`string`[]\>

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

@@ -1,43 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / setCookie
-
-# Function: setCookie()
-
-> **setCookie**(`ctr`, `name`, `value`, `opt`): `void`
-
-Defined in: [lib/core.ts:50](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L50)
-
-设置 cookie
-
-## Parameters
-
-### ctr
-
-[`Ctr`](../../../sys/ctr/classes/Ctr.md)
-
-ctr 实例
-
-### name
-
-`string`
-
-名
-
-### value
-
-`string`
-
-值
-
-### opt
-
-[`ICookieOptions`](../interfaces/ICookieOptions.md) = `{}`
-
-选项，ttl, 默认和 undefined 为关闭浏览器失效
-
-## Returns
-
-`void`

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

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / setGlobal
-
-# Function: setGlobal()
-
-> **setGlobal**(`key`, `data`, `hosts?`): `Promise`\<`string`[]\>
-
-Defined in: [lib/core.ts:655](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L655)
-
-设置跨线程/指定的局域网主机的全局变量
-
-## Parameters
-
-### key
-
-`string`
-
-变量名
-
-### data
-
-`any`
-
-变量值
-
-### hosts?
-
-局域网列表
-
-`string`[] | `"config"`
-
-## Returns
-
-`Promise`\<`string`[]\>

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

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

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

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

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

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

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

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