@maiyunnet/kebab 7.6.1 → 7.6.3

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

@@ -1,43 +0,0 @@
-[**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

@@ -1,41 +0,0 @@
-[**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

@@ -1,31 +0,0 @@
-[**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

@@ -1,31 +0,0 @@
-[**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

@@ -1,37 +0,0 @@
-[**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

@@ -1,31 +0,0 @@
-[**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

@@ -1,31 +0,0 @@
-[**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

@@ -1,63 +0,0 @@
-[**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

@@ -1,25 +0,0 @@
-[**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

@@ -1,25 +0,0 @@
-[**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

@@ -1,31 +0,0 @@
-[**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

@@ -1,39 +0,0 @@
-[**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`\>

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

@@ -1,47 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / putContent
-
-# Function: putContent()
-
-> **putContent**(`path`, `data`, `options`): `Promise`\<`boolean`\>
-
-Defined in: [lib/fs.ts:93](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L93)
-
-写入文件内容
-
-## Parameters
-
-### path
-
-`string`
-
-文件路径
-
-### data
-
-要写入的内容
-
-`string` | `Buffer`\<`ArrayBufferLike`\>
-
-### options
-
-选项
-
-#### encoding?
-
-`BufferEncoding`
-
-#### flag?
-
-`string`
-
-#### mode?
-
-`number`
-
-## Returns
-
-`Promise`\<`boolean`\>

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

@@ -1,29 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / readDir
-
-# Function: readDir()
-
-> **readDir**(`path`, `encoding?`): `Promise`\<`Dirent`\<`string`\>[]\>
-
-Defined in: [lib/fs.ts:307](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L307)
-
-获取文件夹下文件列表
-
-## Parameters
-
-### path
-
-`string`
-
-文件夹路径
-
-### encoding?
-
-`BufferEncoding`
-
-## Returns
-
-`Promise`\<`Dirent`\<`string`\>[]\>

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

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / readLink
-
-# Function: readLink()
-
-> **readLink**(`path`, `encoding?`): `Promise`\<`string` \| `null`\>
-
-Defined in: [lib/fs.ts:115](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L115)
-
-读取链接的 target
-
-## Parameters
-
-### path
-
-`string`
-
-要读取的路径
-
-### encoding?
-
-`BufferEncoding`
-
-编码
-
-## Returns
-
-`Promise`\<`string` \| `null`\>

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

@@ -1,43 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / readToResponse
-
-# Function: readToResponse()
-
-> **readToResponse**(`path`, `req`, `res`, `stat?`): `Promise`\<`void`\>
-
-Defined in: [lib/fs.ts:479](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L479)
-
-读取文件并输出到 http 的 response
-
-## Parameters
-
-### path
-
-`string`
-
-文件绝对路径
-
-### req
-
-http 请求对象
-
-`IncomingMessage` | `Http2ServerRequest`
-
-### res
-
-http 响应对象
-
-`Http2ServerResponse`\<`Http2ServerRequest`\> | `ServerResponse`\<`IncomingMessage`\>
-
-### stat?
-
-文件的 stat（如果有）
-
-`Stats` | `null`
-
-## Returns
-
-`Promise`\<`void`\>

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

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / rename
-
-# Function: rename()
-
-> **rename**(`oldPath`, `newPath`): `Promise`\<`boolean`\>
-
-Defined in: [lib/fs.ts:293](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L293)
-
-重命名/移动文件文件夹
-
-## Parameters
-
-### oldPath
-
-`string`
-
-老名
-
-### newPath
-
-`string`
-
-新名
-
-## Returns
-
-`Promise`\<`boolean`\>

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

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / rmdir
-
-# Function: rmdir()
-
-> **rmdir**(`path`): `Promise`\<`boolean`\>
-
-Defined in: [lib/fs.ts:228](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L228)
-
-删除空目录
-
-## Parameters
-
-### path
-
-`string`
-
-要删除的目录
-
-## Returns
-
-`Promise`\<`boolean`\>

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

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / rmdirDeep
-
-# Function: rmdirDeep()
-
-> **rmdirDeep**(`path`): `Promise`\<`boolean`\>
-
-Defined in: [lib/fs.ts:246](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L246)
-
-Danger 危险：危险函数，尽量不要使用
-This is a danger function, please don't use it
-删除一个非空目录
-
-## Parameters
-
-### path
-
-`string`
-
-## Returns
-
-`Promise`\<`boolean`\>

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

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / stats
-
-# Function: stats()
-
-> **stats**(`path`): `Promise`\<`Stats` \| `null`\>
-
-Defined in: [lib/fs.ts:169](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L169)
-
-获取对象是否存在，存在则返回 stats 对象，否则返回 null
-
-## Parameters
-
-### path
-
-`string`
-
-对象路径
-
-## Returns
-
-`Promise`\<`Stats` \| `null`\>