@maiyunnet/kebab 7.6.0 → 7.6.1

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

@@ -0,0 +1,75 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/db](../index.md) / IPacket
+
+# Interface: IPacket
+
+Defined in: [lib/db.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L40)
+
+exec 返回对象
+
+## Properties
+
+### error
+
+> **error**: \{\[`key`: `string`\]: `any`; `errno`: `number`; `message`: `string`; \} \| `null`
+
+Defined in: [lib/db.ts:53](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L53)
+
+***
+
+### fields
+
+> **fields**: `object`[]
+
+Defined in: [lib/db.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L47)
+
+#### length
+
+> **length**: `number`
+
+字段格式长度
+
+#### name
+
+> **name**: `string`
+
+字段名
+
+***
+
+### packet
+
+> **packet**: \{ `affected`: `number`; `insert`: `number`; \} \| `null`
+
+Defined in: [lib/db.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L41)
+
+#### Type Declaration
+
+\{ `affected`: `number`; `insert`: `number`; \}
+
+#### affected
+
+> **affected**: `number`
+
+受影响的行数
+
+#### insert
+
+> **insert**: `number`
+
+插入的 id
+
+`null`
+
+***
+
+### result
+
+> **result**: `number`
+
+Defined in: [lib/db.ts:59](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L59)
+
+1-正常,-500-服务器错误

package/doc/sc/api/lib/db/pool/classes/Pool.md

@@ -0,0 +1,143 @@
+[**Documents for @maiyunnet/kebab**](../../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/db/pool](../index.md) / Pool
+
+# Class: Pool
+
+Defined in: [lib/db/pool.ts:115](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L115)
+
+数据库连接池对象
+
+## Constructors
+
+### Constructor
+
+> **new Pool**(`etc`, `opt`): `Pool`
+
+Defined in: [lib/db/pool.ts:126](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L126)
+
+#### Parameters
+
+##### etc
+
+[`IConfigDb`](../../../../index/interfaces/IConfigDb.md)
+
+##### opt
+
+###### service
+
+[`ESERVICE`](../../enumerations/ESERVICE.md)
+
+服务商
+
+#### Returns
+
+`Pool`
+
+## Methods
+
+### beginTransaction()
+
+> **beginTransaction**(`ctr`): `Promise`\<[`Transaction`](../../tran/classes/Transaction.md) \| `null`\>
+
+Defined in: [lib/db/pool.ts:189](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L189)
+
+开启事务，返回事务对象并锁定连接，别人任何人不可用，有 ctr 的话必传 this，独立执行时可传 null
+
+#### Parameters
+
+##### ctr
+
+[`Ctr`](../../../../sys/ctr/classes/Ctr.md) | `null`
+
+#### Returns
+
+`Promise`\<[`Transaction`](../../tran/classes/Transaction.md) \| `null`\>
+
+***
+
+### execute()
+
+> **execute**(`sql`, `values?`): `Promise`\<[`IPacket`](../../interfaces/IPacket.md)\>
+
+Defined in: [lib/db/pool.ts:169](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L169)
+
+执行一条 SQL 并获得影响行数对象 packet，连接失败抛出错误
+
+#### Parameters
+
+##### sql
+
+`string`
+
+执行的 SQL 字符串
+
+##### values?
+
+[`DbValue`](../../../../index/type-aliases/DbValue.md)[]
+
+要替换的 data 数据
+
+#### Returns
+
+`Promise`\<[`IPacket`](../../interfaces/IPacket.md)\>
+
+***
+
+### getQueries()
+
+> **getQueries**(): `number`
+
+Defined in: [lib/db/pool.ts:321](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L321)
+
+获取 SQL 执行次数
+
+#### Returns
+
+`number`
+
+***
+
+### getService()
+
+> **getService**(): [`ESERVICE`](../../enumerations/ESERVICE.md)
+
+Defined in: [lib/db/pool.ts:135](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L135)
+
+获取当前连接的服务商
+
+#### Returns
+
+[`ESERVICE`](../../enumerations/ESERVICE.md)
+
+***
+
+### query()
+
+> **query**(`sql`, `values?`): `Promise`\<[`IData`](../../interfaces/IData.md)\>
+
+Defined in: [lib/db/pool.ts:145](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L145)
+
+执行一条 SQL，无视顺序和相同连接，随用随取
+
+#### Parameters
+
+##### sql
+
+`string`
+
+执行的 SQL 字符串
+
+##### values?
+
+[`DbValue`](../../../../index/type-aliases/DbValue.md)[]
+
+要替换的 data 数据
+
+#### Returns
+
+`Promise`\<[`IData`](../../interfaces/IData.md)\>
+
+error.errno = -500 表示系统错误

package/doc/sc/api/lib/db/pool/functions/getConnectionList.md

@@ -0,0 +1,17 @@
+[**Documents for @maiyunnet/kebab**](../../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/db/pool](../index.md) / getConnectionList
+
+# Function: getConnectionList()
+
+> **getConnectionList**(): [`IConnectionInfo`](../interfaces/IConnectionInfo.md)[]
+
+Defined in: [lib/db/pool.ts:35](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L35)
+
+获取当前连接池中所有连接的信息
+
+## Returns
+
+[`IConnectionInfo`](../interfaces/IConnectionInfo.md)[]

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

@@ -0,0 +1,19 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / lib/db/pool
+
+# lib/db/pool
+
+## Classes
+
+- [Pool](classes/Pool.md)
+
+## Interfaces
+
+- [IConnectionInfo](interfaces/IConnectionInfo.md)
+
+## Functions
+
+- [getConnectionList](functions/getConnectionList.md)

package/doc/sc/api/lib/db/pool/interfaces/IConnectionInfo.md

@@ -0,0 +1,91 @@
+[**Documents for @maiyunnet/kebab**](../../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/db/pool](../index.md) / IConnectionInfo
+
+# Interface: IConnectionInfo
+
+Defined in: [lib/db/pool.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L18)
+
+连接信息
+
+## Properties
+
+### host
+
+> **host**: `string`
+
+Defined in: [lib/db/pool.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L22)
+
+***
+
+### id
+
+> **id**: `number`
+
+Defined in: [lib/db/pool.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L19)
+
+***
+
+### last
+
+> **last**: `number`
+
+Defined in: [lib/db/pool.ts:21](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L21)
+
+***
+
+### lost
+
+> **lost**: `boolean`
+
+Defined in: [lib/db/pool.ts:27](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L27)
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [lib/db/pool.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L24)
+
+***
+
+### port
+
+> **port**: `number`
+
+Defined in: [lib/db/pool.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L23)
+
+***
+
+### service
+
+> **service**: [`ESERVICE`](../../enumerations/ESERVICE.md)
+
+Defined in: [lib/db/pool.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L20)
+
+***
+
+### transaction
+
+> **transaction**: `boolean`
+
+Defined in: [lib/db/pool.ts:29](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L29)
+
+***
+
+### user
+
+> **user**: `string`
+
+Defined in: [lib/db/pool.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L25)
+
+***
+
+### using
+
+> **using**: `boolean`
+
+Defined in: [lib/db/pool.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L28)

package/doc/sc/api/lib/db/tran/classes/Transaction.md

@@ -0,0 +1,137 @@
+[**Documents for @maiyunnet/kebab**](../../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/db/tran](../index.md) / Transaction
+
+# Class: Transaction
+
+Defined in: [lib/db/tran.ts:9](https://github.com/maiyunnet/kebab/blob/master/lib/db/tran.ts#L9)
+
+事务连接对象，commit 和 rollback 后将无法使用
+
+## Constructors
+
+### Constructor
+
+> **new Transaction**(`ctr`, `conn`, `opts`): `Transaction`
+
+Defined in: [lib/db/tran.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/db/tran.ts#L28)
+
+#### Parameters
+
+##### ctr
+
+[`Ctr`](../../../../sys/ctr/classes/Ctr.md) | `null`
+
+##### conn
+
+[`Connection`](../../conn/classes/Connection.md)
+
+##### opts
+
+###### danger?
+
+`number`
+
+###### warning?
+
+`number`
+
+#### Returns
+
+`Transaction`
+
+## Methods
+
+### commit()
+
+> **commit**(): `Promise`\<`boolean`\>
+
+Defined in: [lib/db/tran.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib/db/tran.ts#L104)
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### execute()
+
+> **execute**(`sql`, `values?`): `Promise`\<[`IPacket`](../../interfaces/IPacket.md)\>
+
+Defined in: [lib/db/tran.ts:85](https://github.com/maiyunnet/kebab/blob/master/lib/db/tran.ts#L85)
+
+执行一条 SQL 并获得影响行数对象 packet，连接失败抛出错误
+
+#### Parameters
+
+##### sql
+
+`string`
+
+执行的 SQL 字符串
+
+##### values?
+
+[`DbValue`](../../../../index/type-aliases/DbValue.md)[]
+
+要替换的 data 数据
+
+#### Returns
+
+`Promise`\<[`IPacket`](../../interfaces/IPacket.md)\>
+
+***
+
+### getService()
+
+> **getService**(): [`ESERVICE`](../../enumerations/ESERVICE.md) \| `null`
+
+Defined in: [lib/db/tran.ts:52](https://github.com/maiyunnet/kebab/blob/master/lib/db/tran.ts#L52)
+
+获取当前连接的服务商
+
+#### Returns
+
+[`ESERVICE`](../../enumerations/ESERVICE.md) \| `null`
+
+***
+
+### query()
+
+> **query**(`sql`, `values?`): `Promise`\<[`IData`](../../interfaces/IData.md)\>
+
+Defined in: [lib/db/tran.ts:61](https://github.com/maiyunnet/kebab/blob/master/lib/db/tran.ts#L61)
+
+在事务连接中执行一条 SQL
+
+#### Parameters
+
+##### sql
+
+`string`
+
+执行的 SQL 字符串
+
+##### values?
+
+[`DbValue`](../../../../index/type-aliases/DbValue.md)[]
+
+要替换的 data 数据
+
+#### Returns
+
+`Promise`\<[`IData`](../../interfaces/IData.md)\>
+
+***
+
+### rollback()
+
+> **rollback**(): `Promise`\<`boolean`\>
+
+Defined in: [lib/db/tran.ts:126](https://github.com/maiyunnet/kebab/blob/master/lib/db/tran.ts#L126)
+
+#### Returns
+
+`Promise`\<`boolean`\>

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

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

package/doc/sc/api/lib/dns/classes/Dns.md

@@ -0,0 +1,187 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/dns](../index.md) / Dns
+
+# Class: Dns
+
+Defined in: [lib/dns.ts:101](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L101)
+
+## Constructors
+
+### Constructor
+
+> **new Dns**(`ctr`, `opt`): `Dns`
+
+Defined in: [lib/dns.ts:106](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L106)
+
+#### Parameters
+
+##### ctr
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+##### opt
+
+[`IOptions`](../interfaces/IOptions.md)
+
+#### Returns
+
+`Dns`
+
+## Methods
+
+### addDomainRecord()
+
+> **addDomainRecord**(`opt`): `Promise`\<[`IAddDomainRecord`](../interfaces/IAddDomainRecord.md) \| `null`\>
+
+Defined in: [lib/dns.ts:224](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L224)
+
+添加记录
+
+#### Parameters
+
+##### opt
+
+参数
+
+###### domain
+
+`string`
+
+###### line?
+
+[`ERECORDLINE`](../enumerations/ERECORDLINE.md)
+
+###### mx?
+
+`number`
+
+###### sub
+
+`string`
+
+###### ttl?
+
+`number`
+
+###### type
+
+`string`
+
+###### value
+
+`string`
+
+#### Returns
+
+`Promise`\<[`IAddDomainRecord`](../interfaces/IAddDomainRecord.md) \| `null`\>
+
+***
+
+### deleteDomainRecord()
+
+> **deleteDomainRecord**(`opt`): `Promise`\<\{ `success`: `boolean`; \} \| `null`\>
+
+Defined in: [lib/dns.ts:359](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L359)
+
+删除记录
+
+#### Parameters
+
+##### opt
+
+参数
+
+###### domain
+
+`string`
+
+###### id
+
+`string`
+
+#### Returns
+
+`Promise`\<\{ `success`: `boolean`; \} \| `null`\>
+
+***
+
+### getDomainList()
+
+> **getDomainList**(`opt`): `Promise`\<[`IDomainList`](../interfaces/IDomainList.md) \| `null`\>
+
+Defined in: [lib/dns.ts:158](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L158)
+
+获取域名列表
+
+#### Parameters
+
+##### opt
+
+参数
+
+###### length?
+
+`number`
+
+###### offset?
+
+`number`
+
+#### Returns
+
+`Promise`\<[`IDomainList`](../interfaces/IDomainList.md) \| `null`\>
+
+***
+
+### updateDomainRecord()
+
+> **updateDomainRecord**(`opt`): `Promise`\<[`IAddDomainRecord`](../interfaces/IAddDomainRecord.md) \| `null`\>
+
+Defined in: [lib/dns.ts:290](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L290)
+
+修改记录
+
+#### Parameters
+
+##### opt
+
+参数
+
+###### domain
+
+`string`
+
+###### line?
+
+[`ERECORDLINE`](../enumerations/ERECORDLINE.md)
+
+###### mx?
+
+`number`
+
+###### record
+
+`string`
+
+###### sub
+
+`string`
+
+###### ttl?
+
+`number`
+
+###### type
+
+`string`
+
+###### value
+
+`string`
+
+#### Returns
+
+`Promise`\<[`IAddDomainRecord`](../interfaces/IAddDomainRecord.md) \| `null`\>