@maiyunnet/kebab 7.5.0 → 7.6.1

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / symlink
+
+# Function: symlink()
+
+> **symlink**(`filePath`, `linkPath`, `type?`): `Promise`\<`boolean`\>
+
+Defined in: [lib/fs.ts:132](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L132)
+
+把源文件创建一个 link
+
+## Parameters
+
+### filePath
+
+`string`
+
+源文件
+
+### linkPath
+
+`string`
+
+连接路径
+
+### type?
+
+仅 Windows，类型，默认 file
+
+`"file"` | `"dir"` | `"junction"`
+
+## Returns
+
+`Promise`\<`boolean`\>

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

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/fs](../index.md) / unlink
+
+# Function: unlink()
+
+> **unlink**(`path`): `Promise`\<`boolean`\>
+
+Defined in: [lib/fs.ts:146](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L146)
+
+删除一个文件
+
+## Parameters
+
+### path
+
+`string`
+
+要删除的文件路径
+
+## Returns
+
+`Promise`\<`boolean`\>

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

@@ -0,0 +1,30 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/fs
+
+# lib/fs
+
+## Functions
+
+- [chmod](functions/chmod.md)
+- [copyFile](functions/copyFile.md)
+- [copyFolder](functions/copyFolder.md)
+- [createReadStream](functions/createReadStream.md)
+- [createWriteStream](functions/createWriteStream.md)
+- [getContent](functions/getContent.md)
+- [isDir](functions/isDir.md)
+- [isFile](functions/isFile.md)
+- [mkdir](functions/mkdir.md)
+- [pipe](functions/pipe.md)
+- [putContent](functions/putContent.md)
+- [readDir](functions/readDir.md)
+- [readLink](functions/readLink.md)
+- [readToResponse](functions/readToResponse.md)
+- [rename](functions/rename.md)
+- [rmdir](functions/rmdir.md)
+- [rmdirDeep](functions/rmdirDeep.md)
+- [stats](functions/stats.md)
+- [symlink](functions/symlink.md)
+- [unlink](functions/unlink.md)