@maiyunnet/kebab 7.6.1 → 7.6.3

package/doc/sc/api/lib/ssh/shell/classes/Connection.md

@@ -1,189 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/ssh/shell](../index.md) / Connection
-
-# Class: Connection
-
-Defined in: [lib/ssh/shell.ts:9](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/shell.ts#L9)
-
-## Constructors
-
-### Constructor
-
-> **new Connection**(`stream`): `Connection`
-
-Defined in: [lib/ssh/shell.ts:14](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/shell.ts#L14)
-
-#### Parameters
-
-##### stream
-
-`ClientChannel`
-
-#### Returns
-
-`Connection`
-
-## Methods
-
-### close()
-
-> **close**(`cmd?`, `encoding?`): `Promise`\<`void`\>
-
-Defined in: [lib/ssh/shell.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/shell.ts#L77)
-
-关闭 shell
-
-#### Parameters
-
-##### cmd?
-
-命令
-
-`string` | `Buffer`\<`ArrayBufferLike`\>
-
-##### encoding?
-
-`BufferEncoding`
-
-编码
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### getContent()
-
-> **getContent**(`tryCount`): `Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
-
-Defined in: [lib/ssh/shell.ts:96](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/shell.ts#L96)
-
-获取返回值
-
-#### Parameters
-
-##### tryCount
-
-`number` = `10`
-
-如果无知重试次数，1 次为 10 毫秒
-
-#### Returns
-
-`Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
-
-***
-
-### getStream()
-
-> **getStream**(): `ClientChannel`
-
-Defined in: [lib/ssh/shell.ts:119](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/shell.ts#L119)
-
-获取响应读取流对象
-
-#### Returns
-
-`ClientChannel`
-
-***
-
-### send()
-
-> **send**(`cmd`, `encoding?`): `Promise`\<`boolean`\>
-
-Defined in: [lib/ssh/shell.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/shell.ts#L23)
-
-发送指令
-
-#### Parameters
-
-##### cmd
-
-指令
-
-`string` | `Buffer`\<`ArrayBufferLike`\>
-
-##### encoding?
-
-`BufferEncoding`
-
-编码
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-***
-
-### sendCtrlC()
-
-> **sendCtrlC**(): `Promise`\<`boolean`\>
-
-Defined in: [lib/ssh/shell.ts:68](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/shell.ts#L68)
-
-发送中断
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-***
-
-### sendEnter()
-
-> **sendEnter**(): `Promise`\<`boolean`\>
-
-Defined in: [lib/ssh/shell.ts:54](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/shell.ts#L54)
-
-发送 Enter 键
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-***
-
-### sendLine()
-
-> **sendLine**(`cmd`, `encoding?`): `Promise`\<`boolean`\>
-
-Defined in: [lib/ssh/shell.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/shell.ts#L47)
-
-发送带换行的内容（发送并执行）
-
-#### Parameters
-
-##### cmd
-
-`string`
-
-指令
-
-##### encoding?
-
-`BufferEncoding`
-
-编码
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-***
-
-### sendTab()
-
-> **sendTab**(): `Promise`\<`boolean`\>
-
-Defined in: [lib/ssh/shell.ts:61](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/shell.ts#L61)
-
-发送 Tab 键
-
-#### Returns
-
-`Promise`\<`boolean`\>

package/doc/sc/api/lib/ssh/shell/index.md

@@ -1,11 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / lib/ssh/shell
-
-# lib/ssh/shell
-
-## Classes
-
-- [Connection](classes/Connection.md)

package/doc/sc/api/lib/text/functions/getFilename.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / getFilename
-
-# Function: getFilename()
-
-> **getFilename**(`path`): `string`
-
-Defined in: [lib/text.ts:476](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L476)
-
-获取文件名
-
-## Parameters
-
-### path
-
-`string`
-
-文件路径
-
-## Returns
-
-`string`

package/doc/sc/api/lib/text/functions/htmlescape.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / htmlescape
-
-# Function: htmlescape()
-
-> **htmlescape**(`html`): `string`
-
-Defined in: [lib/text.ts:452](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L452)
-
-HTML 特殊字符转换为实体字符
-
-## Parameters
-
-### html
-
-`string`
-
-待转换的 HTML
-
-## Returns
-
-`string`

package/doc/sc/api/lib/text/functions/int2str.md

@@ -1,42 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / int2str
-
-# Function: int2str()
-
-> **int2str**(`int`, `digits`, `decimal`): `string`
-
-Defined in: [lib/text.ts:667](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L667)
-
-为解决精度问题，将整数转换为小数字符串
-以下几个示例都是当 digits 为 3、decimal 为 2 时
-int 传入 2341，返回 '2.34'
-int 传入 2345，返回 '2.35'
-int 传入 23，返回 '0.02'
-int 传入 2，返回 '0.00'
-
-## Parameters
-
-### int
-
-`number`
-
-要转换的整数
-
-### digits
-
-`number` = `4`
-
-小数点左移位数
-
-### decimal
-
-`number` = `2`
-
-最终保留的小数位数
-
-## Returns
-
-`string`

package/doc/sc/api/lib/text/functions/isAscii.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / isAscii
-
-# Function: isAscii()
-
-> **isAscii**(`text`): `boolean`
-
-Defined in: [lib/text.ts:234](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L234)
-
-判断是否在 ascii 字符集内，仅可输入部分
-
-## Parameters
-
-### text
-
-`string`
-
-要判断的文本
-
-## Returns
-
-`boolean`

package/doc/sc/api/lib/text/functions/isDomain.md

@@ -1,27 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / isDomain
-
-# Function: isDomain()
-
-> **isDomain**(`domain`): `boolean`
-
-Defined in: [lib/text.ts:223](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L223)
-
-判断是否是域名
-
-## Parameters
-
-### domain
-
-`string`
-
-域名
-
-## Returns
-
-`boolean`
-
-bool

package/doc/sc/api/lib/text/functions/isEMail.md

@@ -1,23 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / isEMail
-
-# Function: isEMail()
-
-> **isEMail**(`email`): `boolean`
-
-Defined in: [lib/text.ts:192](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L192)
-
-是否是邮件地址
-
-## Parameters
-
-### email
-
-`string`
-
-## Returns
-
-`boolean`

package/doc/sc/api/lib/text/functions/isFalsy.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / isFalsy
-
-# Function: isFalsy()
-
-> **isFalsy**(`val`): `val is TFalsy`
-
-Defined in: [lib/text.ts:618](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L618)
-
-判断一个值是否是虚假的（为 null/undefined/空字符串/false/0）
-
-## Parameters
-
-### val
-
-`any`
-
-要判断的值
-
-## Returns
-
-`val is TFalsy`

package/doc/sc/api/lib/text/functions/isIPv4.md

@@ -1,23 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / isIPv4
-
-# Function: isIPv4()
-
-> **isIPv4**(`ip`): `boolean`
-
-Defined in: [lib/text.ts:202](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L202)
-
-是否是 IPv4
-
-## Parameters
-
-### ip
-
-`string`
-
-## Returns
-
-`boolean`

package/doc/sc/api/lib/text/functions/isIPv6.md

@@ -1,23 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / isIPv6
-
-# Function: isIPv6()
-
-> **isIPv6**(`ip`): `boolean`
-
-Defined in: [lib/text.ts:212](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L212)
-
-是否是 IPv6
-
-## Parameters
-
-### ip
-
-`string`
-
-## Returns
-
-`boolean`

package/doc/sc/api/lib/text/functions/isIdCardCN.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / isIdCardCN
-
-# Function: isIdCardCN()
-
-> **isIdCardCN**(`idcard`): `boolean`
-
-Defined in: [lib/text.ts:346](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L346)
-
-是否是中国大陆身份证号码
-
-## Parameters
-
-### idcard
-
-`string`
-
-身份证号
-
-## Returns
-
-`boolean`

package/doc/sc/api/lib/text/functions/isPhoneCN.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / isPhoneCN
-
-# Function: isPhoneCN()
-
-> **isPhoneCN**(`p`): `boolean`
-
-Defined in: [lib/text.ts:338](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L338)
-
-判断手机号是否是 11 位，不做真实性校验
-
-## Parameters
-
-### p
-
-`string`
-
-手机号
-
-## Returns
-
-`boolean`

package/doc/sc/api/lib/text/functions/isRealPath.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / isRealPath
-
-# Function: isRealPath()
-
-> **isRealPath**(`path`): `boolean`
-
-Defined in: [lib/text.ts:464](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L464)
-
-判断是否是绝对路径，是返回 true，相对路径返回 false
-
-## Parameters
-
-### path
-
-`string`
-
-要判断的路径字符串
-
-## Returns
-
-`boolean`

package/doc/sc/api/lib/text/functions/isTruthy.md

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / isTruthy
-
-# Function: isTruthy()
-
-> **isTruthy**\<`T`\>(`val`): `val is Exclude<T, TFalsy>`
-
-Defined in: [lib/text.ts:626](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L626)
-
-判断一个值是否是真实的（不为 null/undefined/空字符串/false/0）
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### val
-
-`T`
-
-要判断的值
-
-## Returns
-
-`val is Exclude<T, TFalsy>`

package/doc/sc/api/lib/text/functions/logicalOr.md

@@ -1,41 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / logicalOr
-
-# Function: logicalOr()
-
-> **logicalOr**\<`T`, `T2`\>(`v1`, `v2`): `T` *extends* [`TFalsy`](../type-aliases/TFalsy.md) ? `T2` : `T`
-
-Defined in: [lib/text.ts:635](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L635)
-
-类似 || 运算符的效果
-
-## Type Parameters
-
-### T
-
-`T`
-
-### T2
-
-`T2`
-
-## Parameters
-
-### v1
-
-`T`
-
-比对值
-
-### v2
-
-`T2`
-
-比对值
-
-## Returns
-
-`T` *extends* [`TFalsy`](../type-aliases/TFalsy.md) ? `T2` : `T`

package/doc/sc/api/lib/text/functions/match.md

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / match
-
-# Function: match()
-
-> **match**(`str`, `regs`): `boolean`
-
-Defined in: [lib/text.ts:323](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L323)
-
-传入正则进行匹配 str 是否有一项满足
-
-## Parameters
-
-### str
-
-`string`
-
-要检测的字符串
-
-### regs
-
-`RegExp`[]
-
-正则列表
-
-## Returns
-
-`boolean`

package/doc/sc/api/lib/text/functions/nlReplace.md

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / nlReplace
-
-# Function: nlReplace()
-
-> **nlReplace**(`str`, `to`): `string`
-
-Defined in: [lib/text.ts:243](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L243)
-
-换行替换为别的
-
-## Parameters
-
-### str
-
-`string`
-
-要替换的字符串
-
-### to
-
-`string` = '\n'
-
-换行替换符
-
-## Returns
-
-`string`

package/doc/sc/api/lib/text/functions/parseDomain.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / parseDomain
-
-# Function: parseDomain()
-
-> **parseDomain**(`domain`): `Promise`\<[`IDomain`](../interfaces/IDomain.md)\>
-
-Defined in: [lib/text.ts:266](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L266)
-
-解析域名并获取 tld/sld/domain/sub
-
-## Parameters
-
-### domain
-
-`string`
-
-域名
-
-## Returns
-
-`Promise`\<[`IDomain`](../interfaces/IDomain.md)\>