@maiyunnet/kebab 7.5.0 → 7.6.1

package/doc/sc/api/lib/time/functions/format.md

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/time](../index.md) / format
+
+# Function: format()
+
+> **format**(`zone`, `f`, `date?`): `string`
+
+Defined in: [lib/time.ts:161](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L161)
+
+将时间对象转换为时间字符串
+
+## Parameters
+
+### zone
+
+时区小时或 ctr 对象，如 8，设置 null 则以系统时区为准
+
+`number` | [`Ctr`](../../../sys/ctr/classes/Ctr.md) | `null`
+
+### f
+
+`string`
+
+转换格式
+
+### date?
+
+时间对象秒/毫秒级数字均可
+
+`number` | `Date`
+
+## Returns
+
+`string`

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

@@ -0,0 +1,27 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/time](../index.md) / get
+
+# Function: get()
+
+> **get**(`ctr`, `opt`): [`Time`](../classes/Time.md)
+
+Defined in: [lib/time.ts:113](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L113)
+
+创建获取一个时间对象
+
+## Parameters
+
+### ctr
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+### opt
+
+[`IOptions`](../interfaces/IOptions.md) = `{}`
+
+## Returns
+
+[`Time`](../classes/Time.md)

package/doc/sc/api/lib/time/functions/isMs.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/time](../index.md) / isMs
+
+# Function: isMs()
+
+> **isMs**(`time`): `boolean`
+
+Defined in: [lib/time.ts:151](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L151)
+
+是否是毫秒
+
+## Parameters
+
+### time
+
+`number`
+
+要判断的时间戳
+
+## Returns
+
+`boolean`

package/doc/sc/api/lib/time/functions/stamp.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/time](../index.md) / stamp
+
+# Function: stamp()
+
+> **stamp**(`date?`, `zone?`): `number`
+
+Defined in: [lib/time.ts:122](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L122)
+
+获取秒级时间戳
+
+## Parameters
+
+### date?
+
+Date 对象可选
+
+`string` | `Date`
+
+### zone?
+
+时区小时或 ctr 对象，如 8，设置 null 则以系统时区为准
+
+`number` | [`Ctr`](../../../sys/ctr/classes/Ctr.md) | `null`
+
+## Returns
+
+`number`

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

@@ -0,0 +1,28 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/time
+
+# lib/time
+
+## Classes
+
+- [Time](classes/Time.md)
+
+## Interfaces
+
+- [IOptions](interfaces/IOptions.md)
+
+## Variables
+
+- [DAY](variables/DAY.md)
+- [HOUR](variables/HOUR.md)
+- [YEAR](variables/YEAR.md)
+
+## Functions
+
+- [format](functions/format.md)
+- [get](functions/get.md)
+- [isMs](functions/isMs.md)
+- [stamp](functions/stamp.md)

package/doc/sc/api/lib/time/interfaces/IOptions.md

@@ -0,0 +1,29 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/time](../index.md) / IOptions
+
+# Interface: IOptions
+
+Defined in: [lib/time.ts:8](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L8)
+
+## Properties
+
+### data?
+
+> `optional` **data**: `string` \| `number`
+
+Defined in: [lib/time.ts:12](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L12)
+
+字符串、时间戳（秒或毫秒）
+
+***
+
+### zone?
+
+> `optional` **zone**: `number`
+
+Defined in: [lib/time.ts:10](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L10)
+
+时区

package/doc/sc/api/lib/time/variables/DAY.md

@@ -0,0 +1,13 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/time](../index.md) / DAY
+
+# Variable: DAY
+
+> `const` **DAY**: `86400` = `86400`
+
+Defined in: [lib/time.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L18)
+
+一天的秒数

package/doc/sc/api/lib/time/variables/HOUR.md

@@ -0,0 +1,13 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/time](../index.md) / HOUR
+
+# Variable: HOUR
+
+> `const` **HOUR**: `3600` = `3600`
+
+Defined in: [lib/time.ts:16](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L16)
+
+一小时的秒数

package/doc/sc/api/lib/time/variables/YEAR.md

@@ -0,0 +1,13 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/time](../index.md) / YEAR
+
+# Variable: YEAR
+
+> `const` **YEAR**: `31536000` = `31536000`
+
+Defined in: [lib/time.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L20)
+
+一年（365 天）

package/doc/sc/api/lib/turnstile/enumerations/EFACTORY.md

@@ -0,0 +1,27 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/turnstile](../index.md) / EFACTORY
+
+# Enumeration: EFACTORY
+
+Defined in: [lib/turnstile.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/turnstile.ts#L19)
+
+厂家
+
+## Enumeration Members
+
+### CLOUDFLARE
+
+> **CLOUDFLARE**: `0`
+
+Defined in: [lib/turnstile.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/turnstile.ts#L20)
+
+***
+
+### TENCENT
+
+> **TENCENT**: `1`
+
+Defined in: [lib/turnstile.ts:21](https://github.com/maiyunnet/kebab/blob/master/lib/turnstile.ts#L21)

package/doc/sc/api/lib/turnstile/functions/verify.md

@@ -0,0 +1,35 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/turnstile](../index.md) / verify
+
+# Function: verify()
+
+> **verify**(`ctr`, `opt`): `Promise`\<`boolean`\>
+
+Defined in: [lib/turnstile.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/turnstile.ts#L24)
+
+## Parameters
+
+### ctr
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+### opt
+
+#### factory
+
+[`EFACTORY`](../enumerations/EFACTORY.md)
+
+#### ip
+
+`string`
+
+#### token
+
+`string`
+
+## Returns
+
+`Promise`\<`boolean`\>

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

@@ -0,0 +1,15 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/turnstile
+
+# lib/turnstile
+
+## Enumerations
+
+- [EFACTORY](enumerations/EFACTORY.md)
+
+## Functions
+
+- [verify](functions/verify.md)

package/doc/sc/api/lib/vector/classes/Vector.md

@@ -0,0 +1,141 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/vector](../index.md) / Vector
+
+# Class: Vector
+
+Defined in: [lib/vector.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L31)
+
+## Constructors
+
+### Constructor
+
+> **new Vector**(`etc`): `Vector`
+
+Defined in: [lib/vector.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L36)
+
+#### Parameters
+
+##### etc
+
+[`IConfigVector`](../../../index/interfaces/IConfigVector.md)
+
+#### Returns
+
+`Vector`
+
+## Methods
+
+### delete()
+
+> **delete**(`data`): `Promise`\<`false` \| `MutationResult`\>
+
+Defined in: [lib/vector.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L104)
+
+删除数据
+
+#### Parameters
+
+##### data
+
+###### collection
+
+`string`
+
+表名
+
+###### filter
+
+`string`
+
+过滤器，如 word_count > 0 and book_id in [1, 2, 3]
+
+#### Returns
+
+`Promise`\<`false` \| `MutationResult`\>
+
+***
+
+### insert()
+
+> **insert**(`data`): `Promise`\<`false` \| `MutationResult`\>
+
+Defined in: [lib/vector.ts:79](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L79)
+
+插入数据
+
+#### Parameters
+
+##### data
+
+###### collection
+
+`string`
+
+表名
+
+###### data
+
+`RowData`[]
+
+要插入的数据
+
+#### Returns
+
+`Promise`\<`false` \| `MutationResult`\>
+
+***
+
+### seach()
+
+> **seach**(`data`): `Promise`\<`false` \| `SearchResults`\<\{ `collection_name`: `string`; `data`: `number`[]; `filter`: `string` \| `undefined`; `limit`: `number`; `metric_type`: `"L2"` \| `"IP"` \| `"COSINE"`; `output_fields`: `string`[] \| `undefined`; \}\>\>
+
+Defined in: [lib/vector.ts:42](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L42)
+
+搜索
+
+#### Parameters
+
+##### data
+
+###### collection
+
+`string`
+
+表名
+
+###### data
+
+`number`[]
+
+查询的向量
+
+###### fields?
+
+`string`[]
+
+输出的字段，如 ['book_id', 'word_count']，默认全部
+
+###### filter?
+
+`string`
+
+过滤器，如 word_count > 0 and book_id in [1, 2, 3]
+
+###### limit?
+
+`number`
+
+返回的结果数量，默认为 3
+
+###### metric?
+
+`"L2"` \| `"IP"` \| `"COSINE"`
+
+计算两个向量相似度的度量，默认 L2
+
+#### Returns
+
+`Promise`\<`false` \| `SearchResults`\<\{ `collection_name`: `string`; `data`: `number`[]; `filter`: `string` \| `undefined`; `limit`: `number`; `metric_type`: `"L2"` \| `"IP"` \| `"COSINE"`; `output_fields`: `string`[] \| `undefined`; \}\>\>

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

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/vector](../index.md) / get
+
+# Function: get()
+
+> **get**(`ctrEtc`): [`Vector`](../classes/Vector.md)
+
+Defined in: [lib/vector.ts:165](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L165)
+
+创建一个 Vector 对象
+
+## Parameters
+
+### ctrEtc
+
+控制器或配置信息
+
+[`IConfigVector`](../../../index/interfaces/IConfigVector.md) | [`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+## Returns
+
+[`Vector`](../classes/Vector.md)

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

@@ -0,0 +1,19 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/vector
+
+# lib/vector
+
+## Classes
+
+- [Vector](classes/Vector.md)
+
+## Interfaces
+
+- [IOptions](interfaces/IOptions.md)
+
+## Functions
+
+- [get](functions/get.md)

package/doc/sc/api/lib/vector/interfaces/IOptions.md

@@ -0,0 +1,61 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/vector](../index.md) / IOptions
+
+# Interface: IOptions
+
+Defined in: [lib/vector.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L18)
+
+选项
+
+## Properties
+
+### host?
+
+> `optional` **host**: `string`
+
+Defined in: [lib/vector.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L20)
+
+主机地址
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [lib/vector.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L24)
+
+数据库名称
+
+***
+
+### port?
+
+> `optional` **port**: `number`
+
+Defined in: [lib/vector.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L22)
+
+端口号
+
+***
+
+### pwd?
+
+> `optional` **pwd**: `string`
+
+Defined in: [lib/vector.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L28)
+
+密码
+
+***
+
+### user?
+
+> `optional` **user**: `string`
+
+Defined in: [lib/vector.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L26)
+
+用户名