@maiyunnet/kebab 7.6.1 → 7.6.3

package/doc/sc/api/lib/consistent/functions/fast.md

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/consistent](../index.md) / fast
-
-# Function: fast()
-
-> **fast**(`key`, `nodes`, `vcount`): `string` \| `null`
-
-Defined in: [lib/consistent.ts:124](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L124)
-
-快速查找一个 key 属于哪个 node
-
-## Parameters
-
-### key
-
-要查找的key
-
-`string` | `number`
-
-### nodes
-
-node 列表
-
-`string` | `string`[]
-
-### vcount
-
-`number` = `300`
-
-虚拟节点数量
-
-## Returns
-
-`string` \| `null`

package/doc/sc/api/lib/consistent/functions/findInCircle.md

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/consistent](../index.md) / findInCircle
-
-# Function: findInCircle()
-
-> **findInCircle**(`circle`, `key`, `keys`): `string` \| `null`
-
-Defined in: [lib/consistent.ts:188](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L188)
-
-获得一个最近的顺时针节点
-
-## Parameters
-
-### circle
-
-`Record`\<`string`, `string`\>
-
-圆环
-
-### key
-
-为给定键取 Hash，取得顺时针方向上最近的一个虚拟节点对应的实际节点
-
-`string` | `number`
-
-### keys
-
-`string`[] = `[]`
-
-keys，留空则自动从 circle 上取
-
-## Returns
-
-`string` \| `null`

package/doc/sc/api/lib/consistent/functions/get.md

@@ -1,21 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/consistent](../index.md) / get
-
-# Function: get()
-
-> **get**(`vcount`): [`Consistent`](../classes/Consistent.md)
-
-Defined in: [lib/consistent.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L114)
-
-## Parameters
-
-### vcount
-
-`number` = `300`
-
-## Returns
-
-[`Consistent`](../classes/Consistent.md)

package/doc/sc/api/lib/consistent/functions/getRange.md

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/consistent](../index.md) / getRange
-
-# Function: getRange()
-
-> **getRange**(`min`, `max`, `pre`): `string`[]
-
-Defined in: [lib/consistent.ts:153](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L153)
-
-获取区间节点系列
-
-## Parameters
-
-### min
-
-`number`
-
-最小值（含）
-
-### max
-
-`number`
-
-最大值（含）
-
-### pre
-
-`string` = `''`
-
-前导
-
-## Returns
-
-`string`[]

package/doc/sc/api/lib/consistent/functions/hash.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/consistent](../index.md) / hash
-
-# Function: hash()
-
-> **hash**(`val`): `number`
-
-Defined in: [lib/consistent.ts:134](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L134)
-
-hash 函数
-
-## Parameters
-
-### val
-
-要 hash 的值
-
-`string` | `number`
-
-## Returns
-
-`number`

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

@@ -1,20 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../index.md) / lib/consistent
-
-# lib/consistent
-
-## Classes
-
-- [Consistent](classes/Consistent.md)
-
-## Functions
-
-- [addToCircle](functions/addToCircle.md)
-- [fast](functions/fast.md)
-- [findInCircle](functions/findInCircle.md)
-- [get](functions/get.md)
-- [getRange](functions/getRange.md)
-- [hash](functions/hash.md)

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

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / checkType
-
-# Function: checkType()
-
-> **checkType**(`val`, `type`, `tree`): `string`
-
-Defined in: [lib/core.ts:200](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L200)
-
-判断一个对象是否符合示例组，返回空字符串代表校验通过，返回：应该的类型:位置:传入的类型
-
-## Parameters
-
-### val
-
-`any`
-
-对象
-
-### type
-
-`any`
-
-示例组
-
-### tree
-
-`string` = `'root'`
-
-当前树，无需传入
-
-## Returns
-
-`string`

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

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / clone
-
-# Function: clone()
-
-> **clone**\<`T`\>(`obj`): `T`
-
-Defined in: [lib/core.ts:944](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L944)
-
-完整的克隆一份数组/对象
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### obj
-
-`T`
-
-要克隆的对象
-
-## Returns
-
-`T`

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

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

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

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / debug
-
-# Function: debug()
-
-> **debug**(`message?`, ...`optionalParams?`): `void`
-
-Defined in: [lib/core.ts:978](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L978)
-
-打印调试信息，线上环境不会打印
-
-## Parameters
-
-### message?
-
-`any`
-
-参数
-
-### optionalParams?
-
-...`any`[]
-
-参数
-
-## Returns
-
-`void`

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

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / display
-
-# Function: display()
-
-> **display**(`message?`, ...`optionalParams?`): `void`
-
-Defined in: [lib/core.ts:991](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L991)
-
-向控制台直接显示内容，一般情况下禁止使用
-
-## Parameters
-
-### message?
-
-`any`
-
-参数
-
-### optionalParams?
-
-...`any`[]
-
-参数
-
-## Returns
-
-`void`

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

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / emptyObject
-
-# Function: emptyObject()
-
-> **emptyObject**(`obj`, `deep`): `void`
-
-Defined in: [lib/core.ts:409](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L409)
-
-将对象的所有属性清除包括键，不会破坏引用关系，对象变量依然保证是引用状态
-
-## Parameters
-
-### obj
-
-`Record`\<`string`, `any`\>
-
-要清除的对象
-
-### deep
-
-`boolean` = `false`
-
-也将子项都清空，如果子项有独立引用的话也要清空的话则要设置为 true
-
-## Returns
-
-`void`

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

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

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

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

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

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

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

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