@maiyunnet/kebab 7.6.1 → 7.6.3

package/doc/sc/api/lib/buffer/classes/Reader.md

@@ -1,177 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/buffer](../index.md) / Reader
-
-# Class: Reader
-
-Defined in: [lib/buffer.ts:2](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L2)
-
-读对象
-
-## Constructors
-
-### Constructor
-
-> **new Reader**(`buffer`): `Reader`
-
-Defined in: [lib/buffer.ts:9](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L9)
-
-#### Parameters
-
-##### buffer
-
-`Buffer`
-
-#### Returns
-
-`Reader`
-
-## Methods
-
-### length()
-
-> **length**(): `number`
-
-Defined in: [lib/buffer.ts:83](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L83)
-
-获取完整的 buffer 长度
-
-#### Returns
-
-`number`
-
-***
-
-### readBCDString()
-
-> **readBCDString**(`length?`): `string`
-
-Defined in: [lib/buffer.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L49)
-
-读取一个 BCD 编码的字符串（每个字节表示两个数字）
-
-#### Parameters
-
-##### length?
-
-`number`
-
-#### Returns
-
-`string`
-
-***
-
-### readBuffer()
-
-> **readBuffer**(`length?`): `Buffer`
-
-Defined in: [lib/buffer.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L77)
-
-读取 Buffer
-
-#### Parameters
-
-##### length?
-
-`number`
-
-#### Returns
-
-`Buffer`
-
-***
-
-### readString()
-
-> **readString**(`length?`, `encoding?`): `string`
-
-Defined in: [lib/buffer.ts:62](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L62)
-
-读取普通 string
-
-#### Parameters
-
-##### length?
-
-`number`
-
-##### encoding?
-
-`BufferEncoding` = `'utf8'`
-
-#### Returns
-
-`string`
-
-***
-
-### readUInt16BE()
-
-> **readUInt16BE**(): `number`
-
-Defined in: [lib/buffer.ts:21](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L21)
-
-读取一个无符号 16 位整数（大端模式），WORD
-
-#### Returns
-
-`number`
-
-***
-
-### readUInt16LE()
-
-> **readUInt16LE**(): `number`
-
-Defined in: [lib/buffer.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L28)
-
-读取一个无符号 16 位整数（小端模式）
-
-#### Returns
-
-`number`
-
-***
-
-### readUInt32BE()
-
-> **readUInt32BE**(): `number`
-
-Defined in: [lib/buffer.ts:35](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L35)
-
-读取一个无符号 32 位整数（大端模式）, DWORD
-
-#### Returns
-
-`number`
-
-***
-
-### readUInt32LE()
-
-> **readUInt32LE**(): `number`
-
-Defined in: [lib/buffer.ts:42](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L42)
-
-读取一个无符号 32 位整数（小端模式）
-
-#### Returns
-
-`number`
-
-***
-
-### readUInt8()
-
-> **readUInt8**(): `number`
-
-Defined in: [lib/buffer.ts:14](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L14)
-
-读取一个无符号 8 位整数, BYTE
-
-#### Returns
-
-`number`

package/doc/sc/api/lib/buffer/classes/Writer.md

@@ -1,147 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/buffer](../index.md) / Writer
-
-# Class: Writer
-
-Defined in: [lib/buffer.ts:90](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L90)
-
-写对象
-
-## Constructors
-
-### Constructor
-
-> **new Writer**(`size`): `Writer`
-
-Defined in: [lib/buffer.ts:97](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L97)
-
-#### Parameters
-
-##### size
-
-`number`
-
-#### Returns
-
-`Writer`
-
-## Methods
-
-### get()
-
-> **get**(): `Buffer`
-
-Defined in: [lib/buffer.ts:140](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L140)
-
-返回 Buffer 对象
-
-#### Returns
-
-`Buffer`
-
-***
-
-### writeBCDString()
-
-> **writeBCDString**(`value`): `void`
-
-Defined in: [lib/buffer.ts:120](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L120)
-
-[每字节 2 数字] 写入一个 BCD 编码的字符串（仅支持数字）
-
-#### Parameters
-
-##### value
-
-`string`
-
-#### Returns
-
-`void`
-
-***
-
-### writeString()
-
-> **writeString**(`value`, `encoding`): `number`
-
-Defined in: [lib/buffer.ts:130](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L130)
-
-写入普通字符串，返回写入的长度
-
-#### Parameters
-
-##### value
-
-`string`
-
-##### encoding
-
-`BufferEncoding` = `'utf8'`
-
-#### Returns
-
-`number`
-
-***
-
-### writeUInt16BE()
-
-> **writeUInt16BE**(`value`): `void`
-
-Defined in: [lib/buffer.ts:108](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L108)
-
-[2 字节] 写入一个无符号 16 位整数（大端模式）
-
-#### Parameters
-
-##### value
-
-`number`
-
-#### Returns
-
-`void`
-
-***
-
-### writeUInt32BE()
-
-> **writeUInt32BE**(`value`): `void`
-
-Defined in: [lib/buffer.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L114)
-
-[4 字节] 写入一个无符号 32 位整数（大端模式）
-
-#### Parameters
-
-##### value
-
-`number`
-
-#### Returns
-
-`void`
-
-***
-
-### writeUInt8()
-
-> **writeUInt8**(`value`): `void`
-
-Defined in: [lib/buffer.ts:102](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L102)
-
-[1 字节] 写入一个无符号 8 位整数
-
-#### Parameters
-
-##### value
-
-`number`
-
-#### Returns
-
-`void`

package/doc/sc/api/lib/buffer/functions/getReader.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/buffer](../index.md) / getReader
-
-# Function: getReader()
-
-> **getReader**(`buffer`): [`Reader`](../classes/Reader.md)
-
-Defined in: [lib/buffer.ts:150](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L150)
-
-Buffer Reader 对象
-
-## Parameters
-
-### buffer
-
-`Buffer`
-
-要读取的 buffer
-
-## Returns
-
-[`Reader`](../classes/Reader.md)

package/doc/sc/api/lib/buffer/functions/getWriter.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/buffer](../index.md) / getWriter
-
-# Function: getWriter()
-
-> **getWriter**(`size`): [`Writer`](../classes/Writer.md)
-
-Defined in: [lib/buffer.ts:158](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L158)
-
-Buffer Writer 对象
-
-## Parameters
-
-### size
-
-`number`
-
-缓冲区大小
-
-## Returns
-
-[`Writer`](../classes/Writer.md)

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

@@ -1,17 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../index.md) / lib/buffer
-
-# lib/buffer
-
-## Classes
-
-- [Reader](classes/Reader.md)
-- [Writer](classes/Writer.md)
-
-## Functions
-
-- [getReader](functions/getReader.md)
-- [getWriter](functions/getWriter.md)

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

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

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

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

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

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