@maiyunnet/kebab 7.5.0 → 7.6.1

package/doc/sc/api/lib/captcha/classes/Captcha.md

@@ -0,0 +1,79 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/captcha](../index.md) / Captcha
+
+# Class: Captcha
+
+Defined in: [lib/captcha.ts:13](https://github.com/maiyunnet/kebab/blob/master/lib/captcha.ts#L13)
+
+## Constructors
+
+### Constructor
+
+> **new Captcha**(`opt`): `Captcha`
+
+Defined in: [lib/captcha.ts:17](https://github.com/maiyunnet/kebab/blob/master/lib/captcha.ts#L17)
+
+#### Parameters
+
+##### opt
+
+###### height
+
+`number`
+
+###### length
+
+`number`
+
+###### width
+
+`number`
+
+#### Returns
+
+`Captcha`
+
+## Methods
+
+### getBase64()
+
+> **getBase64**(): `string`
+
+Defined in: [lib/captcha.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/captcha.ts#L38)
+
+获取 base64 格式图片
+
+#### Returns
+
+`string`
+
+***
+
+### getBuffer()
+
+> **getBuffer**(): `string`
+
+Defined in: [lib/captcha.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/captcha.ts#L31)
+
+获取图片 Buffer
+
+#### Returns
+
+`string`
+
+***
+
+### getPhrase()
+
+> **getPhrase**(): `string`
+
+Defined in: [lib/captcha.ts:45](https://github.com/maiyunnet/kebab/blob/master/lib/captcha.ts#L45)
+
+获取当前随机码
+
+#### Returns
+
+`string`

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

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/captcha](../index.md) / get
+
+# Function: get()
+
+> **get**(`width`, `height`, `length`): [`Captcha`](../classes/Captcha.md)
+
+Defined in: [lib/captcha.ts:57](https://github.com/maiyunnet/kebab/blob/master/lib/captcha.ts#L57)
+
+获取验证码对象
+
+## Parameters
+
+### width
+
+`number`
+
+宽度
+
+### height
+
+`number`
+
+高度
+
+### length
+
+`number` = `4`
+
+字符个数
+
+## Returns
+
+[`Captcha`](../classes/Captcha.md)

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

@@ -0,0 +1,15 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/captcha
+
+# lib/captcha
+
+## Classes
+
+- [Captcha](classes/Captcha.md)
+
+## Functions
+
+- [get](functions/get.md)

package/doc/sc/api/lib/consistent/classes/Consistent.md

@@ -0,0 +1,135 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/consistent](../index.md) / Consistent
+
+# Class: Consistent
+
+Defined in: [lib/consistent.ts:8](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L8)
+
+## Constructors
+
+### Constructor
+
+> **new Consistent**(`vcount`): `Consistent`
+
+Defined in: [lib/consistent.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L19)
+
+#### Parameters
+
+##### vcount
+
+`number`
+
+#### Returns
+
+`Consistent`
+
+## Methods
+
+### add()
+
+> **add**(`node`): `void`
+
+Defined in: [lib/consistent.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L34)
+
+添加节点
+
+#### Parameters
+
+##### node
+
+node 节点名一个或多个
+
+`string` | `string`[]
+
+#### Returns
+
+`void`
+
+***
+
+### find()
+
+> **find**(`key`): `string` \| `null`
+
+Defined in: [lib/consistent.ts:59](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L59)
+
+获得一个最近的顺时针节点
+
+#### Parameters
+
+##### key
+
+为给定键取 Hash，取得顺时针方向上最近的一个虚拟节点对应的实际节点
+
+`string` | `number`
+
+#### Returns
+
+`string` \| `null`
+
+***
+
+### getVcount()
+
+> **getVcount**(): `number`
+
+Defined in: [lib/consistent.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L26)
+
+获取当前的虚拟节点数量
+
+#### Returns
+
+`number`
+
+***
+
+### migration()
+
+> **migration**(`keys`, `node`): `Record`\<`string`, \{ `new`: `string`; `old`: `string`; \}\>
+
+Defined in: [lib/consistent.ts:74](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L74)
+
+原数据迁移到新地址
+
+#### Parameters
+
+##### keys
+
+原始数据 key 集
+
+`string` | `number` | (`string` \| `number`)[]
+
+##### node
+
+新增的节点一个或多个
+
+`string` | `string`[]
+
+#### Returns
+
+`Record`\<`string`, \{ `new`: `string`; `old`: `string`; \}\>
+
+***
+
+### remove()
+
+> **remove**(`node`): `void`
+
+Defined in: [lib/consistent.ts:43](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L43)
+
+移除节点
+
+#### Parameters
+
+##### node
+
+node 节点名
+
+`string` | `string`[]
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/consistent](../index.md) / addToCircle
+
+# Function: addToCircle()
+
+> **addToCircle**(`circle`, `node`, `vcount`): `void`
+
+Defined in: [lib/consistent.ts:167](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L167)
+
+添加到圆环
+
+## Parameters
+
+### circle
+
+`Record`\<`string`, `string`\>
+
+圆环
+
+### node
+
+node 节点名一个或多个
+
+`string` | `string`[]
+
+### vcount
+
+`number` = `300`
+
+虚拟节点数量
+
+## Returns
+
+`void`

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

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

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

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

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

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

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

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

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

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

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

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

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