@maiyunnet/kebab 7.6.0 → 7.6.1

package/doc/sc/api/lib/s3/classes/S3.md

@@ -0,0 +1,220 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/s3](../index.md) / S3
+
+# Class: S3
+
+Defined in: [lib/s3.ts:43](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L43)
+
+## Constructors
+
+### Constructor
+
+> **new S3**(`ctr`, `opt`): `S3`
+
+Defined in: [lib/s3.ts:52](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L52)
+
+#### Parameters
+
+##### ctr
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+##### opt
+
+[`IOptions`](../interfaces/IOptions.md)
+
+#### Returns
+
+`S3`
+
+## Methods
+
+### deleteObject()
+
+> **deleteObject**(`key`, `bucket?`): `Promise`\<`boolean`\>
+
+Defined in: [lib/s3.ts:168](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L168)
+
+删除对象
+
+#### Parameters
+
+##### key
+
+`string`
+
+对象路径
+
+##### bucket?
+
+`string`
+
+bucket 名
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### deleteObjects()
+
+> **deleteObjects**(`keys`, `bucket?`): `Promise`\<`boolean`\>
+
+Defined in: [lib/s3.ts:188](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L188)
+
+批量删除对象
+
+#### Parameters
+
+##### keys
+
+`string`[]
+
+批量对象路径
+
+##### bucket?
+
+`string`
+
+bucket 名
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### destroy()
+
+> **destroy**(): `void`
+
+Defined in: [lib/s3.ts:230](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L230)
+
+销毁连接，释放资源
+一般会自动垃圾回收，但高频接口也可主动调用
+
+#### Returns
+
+`void`
+
+***
+
+### getObject()
+
+> **getObject**(`key`, `bucket?`): `Promise`\<`false` \| `Readable` & `SdkStreamMixin` \| `Blob` & `SdkStreamMixin` \| `ReadableStream`\<`any`\> & `SdkStreamMixin` \| `undefined`\>
+
+Defined in: [lib/s3.ts:148](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L148)
+
+获取对象流，可通过流获取 buffer 或 text
+
+#### Parameters
+
+##### key
+
+`string`
+
+对象路径
+
+##### bucket?
+
+`string`
+
+bucket 名
+
+#### Returns
+
+`Promise`\<`false` \| `Readable` & `SdkStreamMixin` \| `Blob` & `SdkStreamMixin` \| `ReadableStream`\<`any`\> & `SdkStreamMixin` \| `undefined`\>
+
+***
+
+### headObject()
+
+> **headObject**(`key`, `bucket?`): `Promise`\<`false` \| `HeadObjectCommandOutput`\>
+
+Defined in: [lib/s3.ts:210](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L210)
+
+检测对象是否存在
+
+#### Parameters
+
+##### key
+
+`string`
+
+对象路径
+
+##### bucket?
+
+`string`
+
+bucket 名
+
+#### Returns
+
+`Promise`\<`false` \| `HeadObjectCommandOutput`\>
+
+***
+
+### putObject()
+
+> **putObject**(`key`, `content`, `length?`, `bucket?`): `Promise`\<`false` \| `CompleteMultipartUploadCommandOutput`\>
+
+Defined in: [lib/s3.ts:103](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L103)
+
+上传对象（可传流且也可无需设置 length） --
+
+#### Parameters
+
+##### key
+
+`string`
+
+对象路径
+
+##### content
+
+内容
+
+`string` | `Buffer`\<`ArrayBufferLike`\> | `Readable`
+
+##### length?
+
+设置 contentLength，如果是流模式则需要设置此项，也可以设置为对象参数
+
+`number` | \{ `bucket?`: `string`; `disposition?`: `string`; `length?`: `number`; `type?`: `string`; \}
+
+##### bucket?
+
+`string`
+
+bucket 名
+
+#### Returns
+
+`Promise`\<`false` \| `CompleteMultipartUploadCommandOutput`\>
+
+***
+
+### setBucket()
+
+> **setBucket**(`bucket`): `void`
+
+Defined in: [lib/s3.ts:92](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L92)
+
+修改预定义 bucket
+
+#### Parameters
+
+##### bucket
+
+`string`
+
+bucket 名
+
+#### Returns
+
+`void`

package/doc/sc/api/lib/s3/enumerations/ESERVICE.md

@@ -0,0 +1,43 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/s3](../index.md) / ESERVICE
+
+# Enumeration: ESERVICE
+
+Defined in: [lib/s3.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L20)
+
+服务商定义
+
+## Enumeration Members
+
+### ALIBABA
+
+> **ALIBABA**: `2`
+
+Defined in: [lib/s3.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L23)
+
+***
+
+### AMAZON
+
+> **AMAZON**: `0`
+
+Defined in: [lib/s3.ts:21](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L21)
+
+***
+
+### CF
+
+> **CF**: `3`
+
+Defined in: [lib/s3.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L24)
+
+***
+
+### TENCENT
+
+> **TENCENT**: `1`
+
+Defined in: [lib/s3.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L22)

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

@@ -0,0 +1,29 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/s3](../index.md) / get
+
+# Function: get()
+
+> **get**(`ctr`, `opt`): [`S3`](../classes/S3.md)
+
+Defined in: [lib/s3.ts:240](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L240)
+
+创建一个对象存储对象
+
+## Parameters
+
+### ctr
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+### opt
+
+[`IOptions`](../interfaces/IOptions.md)
+
+选项
+
+## Returns
+
+[`S3`](../classes/S3.md)

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

@@ -0,0 +1,23 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/s3
+
+# lib/s3
+
+## Enumerations
+
+- [ESERVICE](enumerations/ESERVICE.md)
+
+## Classes
+
+- [S3](classes/S3.md)
+
+## Interfaces
+
+- [IOptions](interfaces/IOptions.md)
+
+## Functions
+
+- [get](functions/get.md)

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

@@ -0,0 +1,71 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/s3](../index.md) / IOptions
+
+# Interface: IOptions
+
+Defined in: [lib/s3.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L28)
+
+选项
+
+## Properties
+
+### account?
+
+> `optional` **account**: `string`
+
+Defined in: [lib/s3.ts:32](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L32)
+
+cf r2 使用
+
+***
+
+### bucket?
+
+> `optional` **bucket**: `string`
+
+Defined in: [lib/s3.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L40)
+
+预定义 bucket
+
+***
+
+### region?
+
+> `optional` **region**: `string`
+
+Defined in: [lib/s3.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L38)
+
+区域
+
+***
+
+### secretId?
+
+> `optional` **secretId**: `string`
+
+Defined in: [lib/s3.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L34)
+
+密钥键
+
+***
+
+### secretKey?
+
+> `optional` **secretKey**: `string`
+
+Defined in: [lib/s3.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L36)
+
+密钥值
+
+***
+
+### service
+
+> **service**: [`ESERVICE`](../enumerations/ESERVICE.md)
+
+Defined in: [lib/s3.ts:30](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L30)
+
+服务商 -

package/doc/sc/api/lib/scan/classes/Scan.md

@@ -0,0 +1,127 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/scan](../index.md) / Scan
+
+# Class: Scan
+
+Defined in: [lib/scan.ts:44](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L44)
+
+## Constructors
+
+### Constructor
+
+> **new Scan**(`link`, `token?`, `opt?`): `Scan`
+
+Defined in: [lib/scan.ts:58](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L58)
+
+#### Parameters
+
+##### link
+
+[`Pool`](../../db/pool/classes/Pool.md) | [`Kv`](../../kv/classes/Kv.md)
+
+##### token?
+
+`string`
+
+##### opt?
+
+[`IOptions`](../interfaces/IOptions.md) = `{}`
+
+#### Returns
+
+`Scan`
+
+## Methods
+
+### createToken()
+
+> **createToken**(): `Promise`\<`boolean`\>
+
+Defined in: [lib/scan.ts:156](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L156)
+
+创建 token，直接应用到本类
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### getTimeLeft()
+
+> **getTimeLeft**(): `number` \| `null`
+
+Defined in: [lib/scan.ts:223](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L223)
+
+获取当前 token 可扫剩余有效期
+
+#### Returns
+
+`number` \| `null`
+
+***
+
+### getToken()
+
+> **getToken**(): `string` \| `null`
+
+Defined in: [lib/scan.ts:201](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L201)
+
+获取当前 token
+
+#### Returns
+
+`string` \| `null`
+
+***
+
+### getTTL()
+
+> **getTTL**(): `number`
+
+Defined in: [lib/scan.ts:216](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L216)
+
+获取设置的有效期
+
+#### Returns
+
+`number`
+
+***
+
+### poll()
+
+> **poll**(): `Promise`\<`any`\>
+
+Defined in: [lib/scan.ts:85](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L85)
+
+生成二维码处的轮询，检查是否被扫码、被录入数据
+
+#### Returns
+
+`Promise`\<`any`\>
+
+-3 系统错误 -2 token 不存在或已过期 -1 无操作, 0 已扫码, 其他返回为存的数据并结束轮询
+
+***
+
+### setTTL()
+
+> **setTTL**(`ttl`): `void`
+
+Defined in: [lib/scan.ts:209](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L209)
+
+设置有效期，设置后的新 token 被创建有效
+
+#### Parameters
+
+##### ttl
+
+`number`
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,33 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/scan](../index.md) / get
+
+# Function: get()
+
+> **get**(`link`, `token?`, `opt?`): `Promise`\<[`Scan`](../classes/Scan.md)\>
+
+Defined in: [lib/scan.ts:251](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L251)
+
+-- 创建 Scan 对象
+
+## Parameters
+
+### link
+
+[`Pool`](../../db/pool/classes/Pool.md) | [`Kv`](../../kv/classes/Kv.md)
+
+### token?
+
+`string`
+
+Token
+
+### opt?
+
+[`IOptions`](../interfaces/IOptions.md) = `{}`
+
+## Returns
+
+`Promise`\<[`Scan`](../classes/Scan.md)\>

package/doc/sc/api/lib/scan/functions/scanned.md

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/scan](../index.md) / scanned
+
+# Function: scanned()
+
+> **scanned**(`link`, `token`, `opt`): `Promise`\<`boolean`\>
+
+Defined in: [lib/scan.ts:265](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L265)
+
+对 token 执行访问操作，通常用户扫码后展示的网页所调用，代表已扫码
+
+## Parameters
+
+### link
+
+Db 或 Kv
+
+[`Pool`](../../db/pool/classes/Pool.md) | [`Kv`](../../kv/classes/Kv.md)
+
+### token
+
+`string`
+
+必填
+
+### opt
+
+[`IStaticOptions`](../interfaces/IStaticOptions.md) = `{}`
+
+参数
+
+## Returns
+
+`Promise`\<`boolean`\>

package/doc/sc/api/lib/scan/functions/setData.md

@@ -0,0 +1,35 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/scan](../index.md) / setData
+
+# Function: setData()
+
+> **setData**(`link`, `token`, `data`, `opt`): `Promise`\<`boolean`\>
+
+Defined in: [lib/scan.ts:323](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L323)
+
+将数据写入 token，通常在客户的逻辑下去写，服务器会 poll 到
+
+## Parameters
+
+### link
+
+[`Pool`](../../db/pool/classes/Pool.md) | [`Kv`](../../kv/classes/Kv.md)
+
+### token
+
+`string`
+
+### data
+
+`string` | `number` | `Record`\<`string`, `any`\>
+
+### opt
+
+[`IStaticOptions`](../interfaces/IStaticOptions.md) = `{}`
+
+## Returns
+
+`Promise`\<`boolean`\>

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

@@ -0,0 +1,22 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/scan
+
+# lib/scan
+
+## Classes
+
+- [Scan](classes/Scan.md)
+
+## Interfaces
+
+- [IOptions](interfaces/IOptions.md)
+- [IStaticOptions](interfaces/IStaticOptions.md)
+
+## Functions
+
+- [get](functions/get.md)
+- [scanned](functions/scanned.md)
+- [setData](functions/setData.md)

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

@@ -0,0 +1,43 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/scan](../index.md) / IOptions
+
+# Interface: IOptions
+
+Defined in: [lib/scan.ts:30](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L30)
+
+Scan 设置的选项
+
+## Properties
+
+### ctr?
+
+> `optional` **ctr**: [`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+Defined in: [lib/scan.ts:32](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L32)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [lib/scan.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L34)
+
+***
+
+### pre?
+
+> `optional` **pre**: `string`
+
+Defined in: [lib/scan.ts:33](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L33)
+
+***
+
+### ttl?
+
+> `optional` **ttl**: `number`
+
+Defined in: [lib/scan.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L31)