@maiyunnet/kebab 7.5.0 → 7.6.1

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

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / exec
+
+# Function: exec()
+
+> **exec**(`command`, `options`): `Promise`\<`string` \| `false`\>
+
+Defined in: [lib/core.ts:467](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L467)
+
+执行命令行
+
+## Parameters
+
+### command
+
+`string`
+
+命令字符串
+
+### options
+
+#### cwd?
+
+`string`
+
+## Returns
+
+`Promise`\<`string` \| `false`\>

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

@@ -0,0 +1,71 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / getLog
+
+# Function: getLog()
+
+> **getLog**(`opt`): `Promise`\<`false` \| `string`[][] \| `null`\>
+
+Defined in: [lib/core.ts:851](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L851)
+
+获取日志内容为一个数组
+
+## Parameters
+
+### opt
+
+参数
+
+#### fend?
+
+`string`
+
+如 -error
+
+#### host?
+
+`string`
+
+获取局域网服务器的日志，为空代表获取本机的
+
+#### hostname
+
+`string`
+
+要查询的头，如 127.0.0.1、system、www.maiyun.net 等
+
+#### limit?
+
+`number`
+
+最大限制，默认 100
+
+#### offset?
+
+`number`
+
+跳过条数
+
+#### path
+
+`string`
+
+如 2024/08/01/22
+
+#### search?
+
+`string`
+
+仅显示被搜索到的行
+
+#### start?
+
+`number`
+
+跳过的字节数，默认不跳过
+
+## Returns
+
+`Promise`\<`false` \| `string`[][] \| `null`\>

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

@@ -0,0 +1,27 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / ip
+
+# Function: ip()
+
+> **ip**(`ctr`, `req?`): `string`
+
+Defined in: [lib/core.ts:328](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L328)
+
+获取 IP（非安全 IP）
+
+## Parameters
+
+### ctr
+
+`IncomingHttpHeaders` | [`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+### req?
+
+`IncomingMessage` | `Http2ServerRequest`
+
+## Returns
+
+`string`

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

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / log
+
+# Function: log()
+
+> **log**(`opt`, `msg`, `fend`): `void`
+
+Defined in: [lib/core.ts:773](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L773)
+
+写入文件日志
+
+## Parameters
+
+### opt
+
+选项
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md) | [`ILogOptions`](../interfaces/ILogOptions.md)
+
+### msg
+
+`string`
+
+自定义内容
+
+### fend
+
+`string` = `''`
+
+文件名追加
+
+## Returns
+
+`void`

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

@@ -0,0 +1,39 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / ls
+
+# Function: ls()
+
+> **ls**(`opt`): `Promise`\<`object`[]\>
+
+Defined in: [lib/core.ts:905](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L905)
+
+获取目录内文件/文件夹列表
+
+## Parameters
+
+### opt
+
+参数
+
+#### encoding?
+
+`BufferEncoding`
+
+#### host?
+
+`string`
+
+获取局域网服务器的目录列表，为空代表获取本机的
+
+#### path
+
+`string`
+
+如 2024/08/01/22，无所谓开头结尾
+
+## Returns
+
+`Promise`\<`object`[]\>

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

@@ -0,0 +1,59 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / muid
+
+# Function: muid()
+
+> **muid**(`ctr`, `opt`): `string`
+
+Defined in: [lib/core.ts:288](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L288)
+
+获取 MUID
+
+## Parameters
+
+### ctr
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+Ctr 对象
+
+### opt
+
+参数
+
+#### bin?
+
+`boolean`
+
+是否含有大小写, 默认 true
+
+#### insert?
+
+`string`
+
+插入指定字符, 最好不超过 2 字符，默认空
+
+#### key?
+
+`string`
+
+多样性混合, 默认空
+
+#### len?
+
+`number`
+
+8 - 32, 默认 8
+
+#### num?
+
+`boolean`
+
+是否含有数字, 默认 true
+
+## Returns
+
+`string`

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

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / objectSort
+
+# Function: objectSort()
+
+> **objectSort**\<`T`\>(`o`): `T`
+
+Defined in: [lib/core.ts:390](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L390)
+
+将对象进行升序排列
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Record`\<`string`, `any`\>
+
+## Parameters
+
+### o
+
+`T`
+
+要重排的对象
+
+## Returns
+
+`T`

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

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

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

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

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

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

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

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

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

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

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

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

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