@maiyunnet/kebab 7.5.0 → 7.6.1

package/doc/sc/api/lib/dns/enumerations/ERECORDLINE.md

@@ -0,0 +1,59 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/dns](../index.md) / ERECORDLINE
+
+# Enumeration: ERECORDLINE
+
+Defined in: [lib/dns.ts:73](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L73)
+
+记录值线路
+
+## Enumeration Members
+
+### DEFAULT
+
+> **DEFAULT**: `0`
+
+Defined in: [lib/dns.ts:74](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L74)
+
+***
+
+### EDU
+
+> **EDU**: `4`
+
+Defined in: [lib/dns.ts:78](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L78)
+
+***
+
+### MOBILE
+
+> **MOBILE**: `3`
+
+Defined in: [lib/dns.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L77)
+
+***
+
+### OVERSEA
+
+> **OVERSEA**: `5`
+
+Defined in: [lib/dns.ts:79](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L79)
+
+***
+
+### TELECOM
+
+> **TELECOM**: `1`
+
+Defined in: [lib/dns.ts:75](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L75)
+
+***
+
+### UNICOM
+
+> **UNICOM**: `2`
+
+Defined in: [lib/dns.ts:76](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L76)

package/doc/sc/api/lib/dns/enumerations/ERECORDTYPE.md

@@ -0,0 +1,67 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/dns](../index.md) / ERECORDTYPE
+
+# Enumeration: ERECORDTYPE
+
+Defined in: [lib/dns.ts:60](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L60)
+
+记录值类型
+
+## Enumeration Members
+
+### A
+
+> **A**: `0`
+
+Defined in: [lib/dns.ts:61](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L61)
+
+***
+
+### AAAA
+
+> **AAAA**: `6`
+
+Defined in: [lib/dns.ts:67](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L67)
+
+***
+
+### CNAME
+
+> **CNAME**: `4`
+
+Defined in: [lib/dns.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L65)
+
+***
+
+### MX
+
+> **MX**: `2`
+
+Defined in: [lib/dns.ts:63](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L63)
+
+***
+
+### NS
+
+> **NS**: `1`
+
+Defined in: [lib/dns.ts:62](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L62)
+
+***
+
+### SRV
+
+> **SRV**: `5`
+
+Defined in: [lib/dns.ts:66](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L66)
+
+***
+
+### TXT
+
+> **TXT**: `3`
+
+Defined in: [lib/dns.ts:64](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L64)

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

@@ -0,0 +1,27 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/dns](../index.md) / ESERVICE
+
+# Enumeration: ESERVICE
+
+Defined in: [lib/dns.ts:21](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L21)
+
+服务商定义
+
+## Enumeration Members
+
+### ALIBABA
+
+> **ALIBABA**: `1`
+
+Defined in: [lib/dns.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L23)
+
+***
+
+### DNSPOD
+
+> **DNSPOD**: `0`
+
+Defined in: [lib/dns.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L22)

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

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

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

@@ -0,0 +1,27 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/dns
+
+# lib/dns
+
+## Enumerations
+
+- [ERECORDLINE](enumerations/ERECORDLINE.md)
+- [ERECORDTYPE](enumerations/ERECORDTYPE.md)
+- [ESERVICE](enumerations/ESERVICE.md)
+
+## Classes
+
+- [Dns](classes/Dns.md)
+
+## Interfaces
+
+- [IAddDomainRecord](interfaces/IAddDomainRecord.md)
+- [IDomainList](interfaces/IDomainList.md)
+- [IOptions](interfaces/IOptions.md)
+
+## Functions
+
+- [get](functions/get.md)

package/doc/sc/api/lib/dns/interfaces/IAddDomainRecord.md

@@ -0,0 +1,27 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/dns](../index.md) / IAddDomainRecord
+
+# Interface: IAddDomainRecord
+
+Defined in: [lib/dns.ts:52](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L52)
+
+添加记录的返回对象
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Defined in: [lib/dns.ts:54](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L54)
+
+***
+
+### success
+
+> **success**: `boolean`
+
+Defined in: [lib/dns.ts:53](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L53)

package/doc/sc/api/lib/dns/interfaces/IDomainList.md

@@ -0,0 +1,43 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/dns](../index.md) / IDomainList
+
+# Interface: IDomainList
+
+Defined in: [lib/dns.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L39)
+
+获取域名列表的返回对象
+
+## Properties
+
+### list
+
+> **list**: `object`[]
+
+Defined in: [lib/dns.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L41)
+
+#### count
+
+> **count**: `number`
+
+#### id
+
+> **id**: `string`
+
+#### name
+
+> **name**: `string`
+
+#### punyCode
+
+> **punyCode**: `string`
+
+***
+
+### total
+
+> **total**: `number`
+
+Defined in: [lib/dns.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L40)

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

@@ -0,0 +1,41 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/dns](../index.md) / IOptions
+
+# Interface: IOptions
+
+Defined in: [lib/dns.ts:27](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L27)
+
+选项
+
+## Properties
+
+### secretId?
+
+> `optional` **secretId**: `string`
+
+Defined in: [lib/dns.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L31)
+
+密钥键
+
+***
+
+### secretKey?
+
+> `optional` **secretKey**: `string`
+
+Defined in: [lib/dns.ts:33](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L33)
+
+密钥值
+
+***
+
+### service
+
+> **service**: [`ESERVICE`](../enumerations/ESERVICE.md)
+
+Defined in: [lib/dns.ts:29](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L29)
+
+服务商 -

package/doc/sc/api/lib/fs/functions/chmod.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / chmod
+
+# Function: chmod()
+
+> **chmod**(`path`, `mod`): `Promise`\<`boolean`\>
+
+Defined in: [lib/fs.ts:278](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L278)
+
+修改权限
+
+## Parameters
+
+### path
+
+`string`
+
+要修改的路径
+
+### mod
+
+权限
+
+`string` | `number`
+
+## Returns
+
+`Promise`\<`boolean`\>

package/doc/sc/api/lib/fs/functions/copyFile.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / copyFile
+
+# Function: copyFile()
+
+> **copyFile**(`src`, `dest`): `Promise`\<`boolean`\>
+
+Defined in: [lib/fs.ts:386](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L386)
+
+复制文件
+
+## Parameters
+
+### src
+
+`string`
+
+源文件
+
+### dest
+
+`string`
+
+目标文件
+
+## Returns
+
+`Promise`\<`boolean`\>

package/doc/sc/api/lib/fs/functions/copyFolder.md

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / copyFolder
+
+# Function: copyFolder()
+
+> **copyFolder**(`from`, `to`, `ignore`): `Promise`\<`number`\>
+
+Defined in: [lib/fs.ts:341](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L341)
+
+复制文件夹里的内容到另一个地方，失败不会回滚
+
+## Parameters
+
+### from
+
+`string`
+
+源，末尾加 /
+
+### to
+
+`string`
+
+目标，末尾加 /
+
+### ignore
+
+`RegExp`[] = `[]`
+
+忽略的文件
+
+## Returns
+
+`Promise`\<`number`\>

package/doc/sc/api/lib/fs/functions/createReadStream.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / createReadStream
+
+# Function: createReadStream()
+
+> **createReadStream**(`path`, `options?`): `ReadStream`
+
+Defined in: [lib/fs.ts:401](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L401)
+
+创建读取文件的流
+
+## Parameters
+
+### path
+
+`string`
+
+文件地址
+
+### options?
+
+编码或配置
+
+`BufferEncoding` | \{ `autoClose?`: `boolean`; `encoding?`: BufferEncoding \| undefined; `end?`: `number`; `flags?`: `string`; `start?`: `number`; \}
+
+## Returns
+
+`ReadStream`

package/doc/sc/api/lib/fs/functions/createWriteStream.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / createWriteStream
+
+# Function: createWriteStream()
+
+> **createWriteStream**(`path`, `options?`): `WriteStream`
+
+Defined in: [lib/fs.ts:448](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L448)
+
+创建写入文件的流
+
+## Parameters
+
+### path
+
+`string`
+
+文件地址
+
+### options?
+
+编码或配置
+
+`BufferEncoding` | \{ `autoClose?`: `boolean`; `encoding?`: BufferEncoding \| undefined; `flags?`: `string`; `mode?`: `number`; `start?`: `number`; \}
+
+## Returns
+
+`WriteStream`

package/doc/sc/api/lib/fs/functions/getContent.md

@@ -0,0 +1,63 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / getContent
+
+# Function: getContent()
+
+读取完整文件或一段
+
+## Param
+
+文件路径
+
+## Param
+
+编码或选项
+
+## Call Signature
+
+> **getContent**(`path`, `options?`): `Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
+
+Defined in: [lib/fs.ts:14](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L14)
+
+### Parameters
+
+#### path
+
+`string`
+
+#### options?
+
+##### end?
+
+`number`
+
+##### start?
+
+`number`
+
+### Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
+
+## Call Signature
+
+> **getContent**(`path`, `options`): `Promise`\<`string` \| `null`\>
+
+Defined in: [lib/fs.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L18)
+
+### Parameters
+
+#### path
+
+`string`
+
+#### options
+
+`BufferEncoding` | \{ `encoding`: `BufferEncoding`; `end?`: `number`; `start?`: `number`; \}
+
+### Returns
+
+`Promise`\<`string` \| `null`\>

package/doc/sc/api/lib/fs/functions/isDir.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / isDir
+
+# Function: isDir()
+
+> **isDir**(`path`): `Promise`\<`false` \| `Stats`\>
+
+Defined in: [lib/fs.ts:182](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L182)
+
+判断是否是目录或目录是否存在，是的话返回 stats
+
+## Parameters
+
+### path
+
+`string`
+
+判断路径
+
+## Returns
+
+`Promise`\<`false` \| `Stats`\>

package/doc/sc/api/lib/fs/functions/isFile.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / isFile
+
+# Function: isFile()
+
+> **isFile**(`path`): `Promise`\<`false` \| `Stats`\>
+
+Defined in: [lib/fs.ts:194](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L194)
+
+判断是否是文件或文件是否存在，是的话返回 stats
+
+## Parameters
+
+### path
+
+`string`
+
+判断路径
+
+## Returns
+
+`Promise`\<`false` \| `Stats`\>

package/doc/sc/api/lib/fs/functions/mkdir.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / mkdir
+
+# Function: mkdir()
+
+> **mkdir**(`path`, `mode`): `Promise`\<`boolean`\>
+
+Defined in: [lib/fs.ts:207](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L207)
+
+深度创建目录，如果最末目录存在，则自动创建成功
+
+## Parameters
+
+### path
+
+`string`
+
+要创建的路径，如 /a/b/c/
+
+### mode
+
+`number` = `0o755`
+
+权限
+
+## Returns
+
+`Promise`\<`boolean`\>

package/doc/sc/api/lib/fs/functions/pipe.md

@@ -0,0 +1,39 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / pipe
+
+# Function: pipe()
+
+> **pipe**(`path`, `destination`, `options?`): `Promise`\<`boolean`\>
+
+Defined in: [lib/fs.ts:431](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L431)
+
+读取文件写入到流，并等待写入完成
+
+## Parameters
+
+### path
+
+`string`
+
+文件地址
+
+### destination
+
+`WritableStream`
+
+要写入的流
+
+### options?
+
+写入后是否终止写入流，默认终止
+
+#### end?
+
+`boolean`
+
+## Returns
+
+`Promise`\<`boolean`\>