@maiyunnet/kebab 7.6.0 → 7.6.1

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

@@ -0,0 +1,40 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/crypto
+
+# lib/crypto
+
+## Variables
+
+- [AES\_256\_CBC](variables/AES_256_CBC.md)
+- [AES\_256\_CTR](variables/AES_256_CTR.md)
+- [AES\_256\_ECB](variables/AES_256_ECB.md)
+- [AES\_256\_GCM](variables/AES_256_GCM.md)
+- [SM4\_CBC](variables/SM4_CBC.md)
+- [SM4\_CFB](variables/SM4_CFB.md)
+- [SM4\_ECB](variables/SM4_ECB.md)
+
+## Functions
+
+- [aesDecrypt](functions/aesDecrypt.md)
+- [aesEncrypt](functions/aesEncrypt.md)
+- [base64Decode](functions/base64Decode.md)
+- [base64Encode](functions/base64Encode.md)
+- [cipherDecrypt](functions/cipherDecrypt.md)
+- [cipherEncrypt](functions/cipherEncrypt.md)
+- [gcmDecrypt](functions/gcmDecrypt.md)
+- [gcmEncrypt](functions/gcmEncrypt.md)
+- [generateKeyPair](functions/generateKeyPair.md)
+- [hashHmac](functions/hashHmac.md)
+- [hashHmacFile](functions/hashHmacFile.md)
+- [privateDecrypt](functions/privateDecrypt.md)
+- [privateEncrypt](functions/privateEncrypt.md)
+- [publicDecrypt](functions/publicDecrypt.md)
+- [publicEncrypt](functions/publicEncrypt.md)
+- [sign](functions/sign.md)
+- [sm4Decrypt](functions/sm4Decrypt.md)
+- [sm4Encrypt](functions/sm4Encrypt.md)
+- [uuid](functions/uuid.md)
+- [verify](functions/verify.md)

package/doc/sc/api/lib/crypto/variables/AES_256_CBC.md

@@ -0,0 +1,13 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / AES\_256\_CBC
+
+# Variable: AES\_256\_CBC
+
+> `const` **AES\_256\_CBC**: `"aes-256-cbc"` = `'aes-256-cbc'`
+
+Defined in: [lib/crypto.ts:146](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L146)
+
+一般不用，兼容性场景下用

package/doc/sc/api/lib/crypto/variables/AES_256_CTR.md

@@ -0,0 +1,13 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / AES\_256\_CTR
+
+# Variable: AES\_256\_CTR
+
+> `const` **AES\_256\_CTR**: `"aes-256-ctr"` = `'aes-256-ctr'`
+
+Defined in: [lib/crypto.ts:148](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L148)
+
+设置 iv 会自动切换为 CTR，流式下使用，非流直接使用 GCM

package/doc/sc/api/lib/crypto/variables/AES_256_ECB.md

@@ -0,0 +1,13 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / AES\_256\_ECB
+
+# Variable: AES\_256\_ECB
+
+> `const` **AES\_256\_ECB**: `"aes-256-ecb"` = `'aes-256-ecb'`
+
+Defined in: [lib/crypto.ts:144](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L144)
+
+勿使用，无 iv 默认，但勿使用

package/doc/sc/api/lib/crypto/variables/AES_256_GCM.md

@@ -0,0 +1,13 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / AES\_256\_GCM
+
+# Variable: AES\_256\_GCM
+
+> `const` **AES\_256\_GCM**: `"aes-256-gcm"` = `'aes-256-gcm'`
+
+Defined in: [lib/crypto.ts:150](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L150)
+
+非流直接使用 GCM

package/doc/sc/api/lib/crypto/variables/SM4_CBC.md

@@ -0,0 +1,11 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / SM4\_CBC
+
+# Variable: SM4\_CBC
+
+> `const` **SM4\_CBC**: `"sm4-cbc"` = `'sm4-cbc'`
+
+Defined in: [lib/crypto.ts:154](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L154)

package/doc/sc/api/lib/crypto/variables/SM4_CFB.md

@@ -0,0 +1,13 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / SM4\_CFB
+
+# Variable: SM4\_CFB
+
+> `const` **SM4\_CFB**: `"sm4-cfb"` = `'sm4-cfb'`
+
+Defined in: [lib/crypto.ts:156](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L156)
+
+SM4 一般用这个，设置 iv，自动就切换成了这个

package/doc/sc/api/lib/crypto/variables/SM4_ECB.md

@@ -0,0 +1,13 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / SM4\_ECB
+
+# Variable: SM4\_ECB
+
+> `const` **SM4\_ECB**: `"sm4-ecb"` = `'sm4-ecb'`
+
+Defined in: [lib/crypto.ts:153](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L153)
+
+SM4 如果未设置 iv，则默认这个

package/doc/sc/api/lib/db/conn/classes/Connection.md

@@ -0,0 +1,315 @@
+[**Documents for @maiyunnet/kebab**](../../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/db/conn](../index.md) / Connection
+
+# Class: Connection
+
+Defined in: [lib/db/conn.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L34)
+
+数据库连接对象
+
+## Constructors
+
+### Constructor
+
+> **new Connection**(`etc`, `link`): `Connection`
+
+Defined in: [lib/db/conn.ts:59](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L59)
+
+#### Parameters
+
+##### etc
+
+[`IConfigDb`](../../../../index/interfaces/IConfigDb.md)
+
+##### link
+
+`Connection` | `Client`
+
+#### Returns
+
+`Connection`
+
+## Methods
+
+### beginTransaction()
+
+> **beginTransaction**(): `Promise`\<`boolean`\>
+
+Defined in: [lib/db/conn.ts:317](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L317)
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### commit()
+
+> **commit**(): `Promise`\<`boolean`\>
+
+Defined in: [lib/db/conn.ts:338](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L338)
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### end()
+
+> **end**(): `Promise`\<`boolean`\>
+
+Defined in: [lib/db/conn.ts:306](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L306)
+
+关闭连接，一般情况下不使用
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### execute()
+
+> **execute**(`sql`, `values?`): `Promise`\<[`IPacket`](../../interfaces/IPacket.md)\>
+
+Defined in: [lib/db/conn.ts:233](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L233)
+
+执行一条 SQL 并获得影响行数对象 packet
+
+#### Parameters
+
+##### sql
+
+`string`
+
+执行的 SQL 字符串
+
+##### values?
+
+[`DbValue`](../../../../index/type-aliases/DbValue.md)[]
+
+要替换的 data 数据
+
+#### Returns
+
+`Promise`\<[`IPacket`](../../interfaces/IPacket.md)\>
+
+***
+
+### getEtc()
+
+> **getEtc**(): [`IConfigDb`](../../../../index/interfaces/IConfigDb.md)
+
+Defined in: [lib/db/conn.ts:68](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L68)
+
+获取连接 etc 信息
+
+#### Returns
+
+[`IConfigDb`](../../../../index/interfaces/IConfigDb.md)
+
+***
+
+### getLast()
+
+> **getLast**(): `number`
+
+Defined in: [lib/db/conn.ts:80](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L80)
+
+获取最后一次获取连接的时间
+
+#### Returns
+
+`number`
+
+***
+
+### getLastSql()
+
+> **getLastSql**(): `object`[]
+
+Defined in: [lib/db/conn.ts:87](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L87)
+
+获取最后两次执行的 sql 字符串
+
+#### Returns
+
+`object`[]
+
+***
+
+### getService()
+
+> **getService**(): [`ESERVICE`](../../enumerations/ESERVICE.md)
+
+Defined in: [lib/db/conn.ts:73](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L73)
+
+获取数据库服务类型
+
+#### Returns
+
+[`ESERVICE`](../../enumerations/ESERVICE.md)
+
+***
+
+### isAvailable()
+
+> **isAvailable**(`last`): `Promise`\<`boolean`\>
+
+Defined in: [lib/db/conn.ts:154](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L154)
+
+通过执行一条语句判断当前连接是否可用
+
+#### Parameters
+
+##### last
+
+`boolean` = `true`
+
+是否刷新最后使用时间（默认刷新）
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### isLost()
+
+> **isLost**(): `boolean`
+
+Defined in: [lib/db/conn.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L104)
+
+是否已经丢失
+
+#### Returns
+
+`boolean`
+
+***
+
+### isTransaction()
+
+> **isTransaction**(): `boolean`
+
+Defined in: [lib/db/conn.ts:111](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L111)
+
+是否是开启事务状态
+
+#### Returns
+
+`boolean`
+
+***
+
+### isUsing()
+
+> **isUsing**(): `boolean`
+
+Defined in: [lib/db/conn.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L118)
+
+获取当前状态是否正在被使用中
+
+#### Returns
+
+`boolean`
+
+***
+
+### query()
+
+> **query**(`sql`, `values?`): `Promise`\<[`IData`](../../interfaces/IData.md)\>
+
+Defined in: [lib/db/conn.ts:177](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L177)
+
+执行一条 SQL 并获得返回数据
+
+#### Parameters
+
+##### sql
+
+`string`
+
+执行的 SQL 字符串
+
+##### values?
+
+[`DbValue`](../../../../index/type-aliases/DbValue.md)[]
+
+要替换的 data 数据
+
+#### Returns
+
+`Promise`\<[`IData`](../../interfaces/IData.md)\>
+
+***
+
+### refreshLast()
+
+> **refreshLast**(): `void`
+
+Defined in: [lib/db/conn.ts:146](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L146)
+
+设定最后使用时间
+
+#### Returns
+
+`void`
+
+***
+
+### rollback()
+
+> **rollback**(): `Promise`\<`boolean`\>
+
+Defined in: [lib/db/conn.ts:356](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L356)
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### setLost()
+
+> **setLost**(): `void`
+
+Defined in: [lib/db/conn.ts:97](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L97)
+
+将本条连接设置为不可用
+
+#### Returns
+
+`void`
+
+***
+
+### used()
+
+> **used**(): `void`
+
+Defined in: [lib/db/conn.ts:139](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L139)
+
+取消占用
+
+#### Returns
+
+`void`
+
+***
+
+### using()
+
+> **using**(): `boolean`
+
+Defined in: [lib/db/conn.ts:125](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L125)
+
+判断是否可用（丢失的也算不可用），返回 true 代表获取成功并自动刷新最后时间
+
+#### Returns
+
+`boolean`

package/doc/sc/api/lib/db/conn/index.md

@@ -0,0 +1,11 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / lib/db/conn
+
+# lib/db/conn
+
+## Classes
+
+- [Connection](classes/Connection.md)

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

@@ -0,0 +1,27 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/db](../index.md) / ESERVICE
+
+# Enumeration: ESERVICE
+
+Defined in: [lib/db.ts:17](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L17)
+
+服务商定义
+
+## Enumeration Members
+
+### MYSQL
+
+> **MYSQL**: `0`
+
+Defined in: [lib/db.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L18)
+
+***
+
+### PGSQL
+
+> **PGSQL**: `1`
+
+Defined in: [lib/db.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L19)

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

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/db](../index.md) / get
+
+# Function: get()
+
+> **get**(`ctrEtc`, `opt`): [`Pool`](../pool/classes/Pool.md)
+
+Defined in: [lib/db.ts:68](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L68)
+
+获取 Db Pool 对象
+
+## Parameters
+
+### ctrEtc
+
+控制器对象或数据库配置信息
+
+[`IConfigDb`](../../../index/interfaces/IConfigDb.md) | [`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+### opt
+
+选项
+
+#### service?
+
+[`ESERVICE`](../enumerations/ESERVICE.md)
+
+服务商，默认 PGSQL
+
+## Returns
+
+[`Pool`](../pool/classes/Pool.md)
+
+Db Pool 对象

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

@@ -0,0 +1,50 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/db
+
+# lib/db
+
+## Enumerations
+
+- [ESERVICE](enumerations/ESERVICE.md)
+
+## Interfaces
+
+- [IData](interfaces/IData.md)
+- [IPacket](interfaces/IPacket.md)
+
+## Functions
+
+- [get](functions/get.md)
+
+## References
+
+### Connection
+
+Re-exports [Connection](conn/classes/Connection.md)
+
+***
+
+### getConnectionList
+
+Re-exports [getConnectionList](pool/functions/getConnectionList.md)
+
+***
+
+### IConnectionInfo
+
+Re-exports [IConnectionInfo](pool/interfaces/IConnectionInfo.md)
+
+***
+
+### Pool
+
+Re-exports [Pool](pool/classes/Pool.md)
+
+***
+
+### Transaction
+
+Re-exports [Transaction](tran/classes/Transaction.md)

package/doc/sc/api/lib/db/interfaces/IData.md

@@ -0,0 +1,57 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/db](../index.md) / IData
+
+# Interface: IData
+
+Defined in: [lib/db.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L23)
+
+query 返回的数据
+
+## Properties
+
+### error
+
+> **error**: \{ `errno`: `number`; `message`: `string`; \} \| `null`
+
+Defined in: [lib/db.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L31)
+
+***
+
+### fields
+
+> **fields**: `object`[]
+
+Defined in: [lib/db.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L25)
+
+#### length
+
+> **length**: `number`
+
+字段格式长度
+
+#### name
+
+> **name**: `string`
+
+字段名
+
+***
+
+### result
+
+> **result**: `number`
+
+Defined in: [lib/db.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L36)
+
+1-正常,-500-服务器错误
+
+***
+
+### rows
+
+> **rows**: `Record`\<`string`, `any`\>[] \| `null`
+
+Defined in: [lib/db.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L24)