@maiyunnet/kebab 7.6.1 → 7.6.3

package/doc/sc/api/lib/ws/interfaces/IConnectOptions.md

@@ -1,95 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ws](../index.md) / IConnectOptions
-
-# Interface: IConnectOptions
-
-Defined in: [lib/ws.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L34)
-
-请求的传入参数选项
-
-## Properties
-
-### cookie?
-
-> `optional` **cookie**: `Record`\<`string`, [`ICookie`](../../net/interfaces/ICookie.md)\>
-
-Defined in: [lib/ws.ts:42](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L42)
-
-cookie 托管对象
-
-***
-
-### headers?
-
-> `optional` **headers**: [`THttpHeaders`](../../net/type-aliases/THttpHeaders.md)
-
-Defined in: [lib/ws.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L40)
-
-***
-
-### hosts?
-
-> `optional` **hosts**: `string` \| `Record`\<`string`, `string`\>
-
-Defined in: [lib/ws.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L38)
-
-自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host
-
-***
-
-### local?
-
-> `optional` **local**: `string`
-
-Defined in: [lib/ws.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L39)
-
-***
-
-### masking?
-
-> `optional` **masking**: `boolean`
-
-Defined in: [lib/ws.ts:46](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L46)
-
-加密模式，默认 true
-
-***
-
-### mode?
-
-> `optional` **mode**: [`EFrameReceiveMode`](../enumerations/EFrameReceiveMode.md)
-
-Defined in: [lib/ws.ts:44](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L44)
-
-小帧模式，默认 false
-
-***
-
-### mproxy?
-
-> `optional` **mproxy**: `object`
-
-Defined in: [lib/ws.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L48)
-
-正向 mproxy 代理，url 如 wss://xxx/abc
-
-#### auth
-
-> **auth**: `string`
-
-#### url
-
-> **url**: `string`
-
-***
-
-### timeout?
-
-> `optional` **timeout**: `number`
-
-Defined in: [lib/ws.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L36)
-
-秒数

package/doc/sc/api/lib/ws/interfaces/IMproxyOptions.md

@@ -1,87 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ws](../index.md) / IMproxyOptions
-
-# Interface: IMproxyOptions
-
-Defined in: [lib/ws.ts:55](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L55)
-
-正向代理请求的传入参数选项
-
-## Properties
-
-### filter()?
-
-> `optional` **filter**: (`h`) => `boolean`
-
-Defined in: [lib/ws.ts:63](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L63)
-
-过滤 header，返回 true 则留下
-
-#### Parameters
-
-##### h
-
-`string`
-
-#### Returns
-
-`boolean`
-
-***
-
-### headers?
-
-> `optional` **headers**: [`THttpHeaders`](../../net/type-aliases/THttpHeaders.md)
-
-Defined in: [lib/ws.ts:61](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L61)
-
-***
-
-### hosts?
-
-> `optional` **hosts**: `string` \| `Record`\<`string`, `string`\>
-
-Defined in: [lib/ws.ts:59](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L59)
-
-自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host
-
-***
-
-### local?
-
-> `optional` **local**: `string`
-
-Defined in: [lib/ws.ts:60](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L60)
-
-***
-
-### masking?
-
-> `optional` **masking**: `boolean`
-
-Defined in: [lib/ws.ts:67](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L67)
-
-加密模式，默认 true
-
-***
-
-### mode?
-
-> `optional` **mode**: [`EFrameReceiveMode`](../enumerations/EFrameReceiveMode.md)
-
-Defined in: [lib/ws.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L65)
-
-小帧模式，默认 false
-
-***
-
-### timeout?
-
-> `optional` **timeout**: `number`
-
-Defined in: [lib/ws.ts:57](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L57)
-
-秒数

package/doc/sc/api/lib/ws/interfaces/IRproxyOptions.md

@@ -1,105 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ws](../index.md) / IRproxyOptions
-
-# Interface: IRproxyOptions
-
-Defined in: [lib/ws.ts:71](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L71)
-
-反向代理请求的传入参数选项
-
-## Properties
-
-### filter()?
-
-> `optional` **filter**: (`h`) => `boolean`
-
-Defined in: [lib/ws.ts:79](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L79)
-
-过滤 header，返回 true 则留下
-
-#### Parameters
-
-##### h
-
-`string`
-
-#### Returns
-
-`boolean`
-
-***
-
-### headers?
-
-> `optional` **headers**: [`THttpHeaders`](../../net/type-aliases/THttpHeaders.md)
-
-Defined in: [lib/ws.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L77)
-
-***
-
-### hosts?
-
-> `optional` **hosts**: `string` \| `Record`\<`string`, `string`\>
-
-Defined in: [lib/ws.ts:75](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L75)
-
-自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host
-
-***
-
-### local?
-
-> `optional` **local**: `string`
-
-Defined in: [lib/ws.ts:76](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L76)
-
-***
-
-### masking?
-
-> `optional` **masking**: `boolean`
-
-Defined in: [lib/ws.ts:83](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L83)
-
-加密模式，默认 true
-
-***
-
-### mode?
-
-> `optional` **mode**: [`EFrameReceiveMode`](../enumerations/EFrameReceiveMode.md)
-
-Defined in: [lib/ws.ts:81](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L81)
-
-小帧模式，默认 false
-
-***
-
-### mproxy?
-
-> `optional` **mproxy**: `object`
-
-Defined in: [lib/ws.ts:85](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L85)
-
-正向 mproxy 代理，url 如 wss://xxx/abc
-
-#### auth
-
-> **auth**: `string`
-
-#### url
-
-> **url**: `string`
-
-***
-
-### timeout?
-
-> `optional` **timeout**: `number`
-
-Defined in: [lib/ws.ts:73](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L73)
-
-秒数

package/doc/sc/api/lib/zip/classes/Zip.md

@@ -1,392 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zip](../index.md) / Zip
-
-# Class: Zip
-
-Defined in: [lib/zip.ts:9](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L9)
-
-本库主要用于读取 zip，请尽量不要用来写入 zip，尤其是大文件 zip
-
-## Constructors
-
-### Constructor
-
-> **new Zip**(`zip`): `Zip`
-
-Defined in: [lib/zip.ts:17](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L17)
-
-#### Parameters
-
-##### zip
-
-`JSZip`
-
-#### Returns
-
-`Zip`
-
-## Methods
-
-### cd()
-
-> **cd**(`dir`): `string`
-
-Defined in: [lib/zip.ts:338](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L338)
-
-进入一个目录（不存在也能进入，需要自行判断）
-返回进入后的路径值
-
-#### Parameters
-
-##### dir
-
-`string`
-
-相对路径或绝对路径
-
-#### Returns
-
-`string`
-
-***
-
-### generate()
-
-> **generate**\<`T`\>(`options`): `Promise`\<[`IZipOutputByType`](../interfaces/IZipOutputByType.md)\[`T`\]\>
-
-Defined in: [lib/zip.ts:350](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L350)
-
-打包 zip
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* keyof [`IZipOutputByType`](../interfaces/IZipOutputByType.md)
-
-#### Parameters
-
-##### options
-
-选项
-
-###### level?
-
-`number`
-
-###### onUpdate?
-
-(`percent`, `currentFile`) => `void`
-
-###### type?
-
-`T`
-
-#### Returns
-
-`Promise`\<[`IZipOutputByType`](../interfaces/IZipOutputByType.md)\[`T`\]\>
-
-***
-
-### getContent()
-
-读取完整文件
-
-#### Param
-
-文件路径
-
-#### Param
-
-返回类型
-
-#### Call Signature
-
-> **getContent**(`path`): `Promise`\<`string` \| `null`\>
-
-Defined in: [lib/zip.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L22)
-
-##### Parameters
-
-###### path
-
-`string`
-
-##### Returns
-
-`Promise`\<`string` \| `null`\>
-
-#### Call Signature
-
-> **getContent**\<`T`\>(`path`, `type`): `Promise`\<[`IZipOutputByType`](../interfaces/IZipOutputByType.md)\[`T`\] \| `null`\>
-
-Defined in: [lib/zip.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L23)
-
-##### Type Parameters
-
-###### T
-
-`T` *extends* keyof [`IZipOutputByType`](../interfaces/IZipOutputByType.md)
-
-##### Parameters
-
-###### path
-
-`string`
-
-###### type
-
-`T`
-
-##### Returns
-
-`Promise`\<[`IZipOutputByType`](../interfaces/IZipOutputByType.md)\[`T`\] \| `null`\>
-
-***
-
-### getList()
-
-> **getList**(): `Promise`\<`Record`\<`string`, `string` \| `Buffer`\<`ArrayBufferLike`\>\>\>
-
-Defined in: [lib/zip.ts:375](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L375)
-
-获取 path 和 string/Buffer 对应的文件列表
-
-#### Returns
-
-`Promise`\<`Record`\<`string`, `string` \| `Buffer`\<`ArrayBufferLike`\>\>\>
-
-***
-
-### isDir()
-
-> **isDir**(`path`): `false` \| [`IZipStats`](../interfaces/IZipStats.md)
-
-Defined in: [lib/zip.ts:134](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L134)
-
-判断是否是目录或目录是否存在，是的话返回 stats
-
-#### Parameters
-
-##### path
-
-`string`
-
-判断路径
-
-#### Returns
-
-`false` \| [`IZipStats`](../interfaces/IZipStats.md)
-
-***
-
-### isFile()
-
-> **isFile**(`path`): `false` \| [`IZipStats`](../interfaces/IZipStats.md)
-
-Defined in: [lib/zip.ts:146](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L146)
-
-判断是否是文件或文件是否存在，是的话返回 stats
-
-#### Parameters
-
-##### path
-
-`string`
-
-判断路径
-
-#### Returns
-
-`false` \| [`IZipStats`](../interfaces/IZipStats.md)
-
-***
-
-### putContent()
-
-> **putContent**\<`T`\>(`path`, `data`, `options`): `void`
-
-Defined in: [lib/zip.ts:51](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L51)
-
-写入文件内容
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* keyof [`IZipInputByType`](../interfaces/IZipInputByType.md)
-
-#### Parameters
-
-##### path
-
-`string`
-
-文件路径
-
-##### data
-
-[`IZipInputByType`](../interfaces/IZipInputByType.md)\[`T`\]
-
-要写入的内容
-
-##### options
-
-选项
-
-###### base64?
-
-`boolean`
-
-###### binary?
-
-`boolean`
-
-###### date?
-
-`Date`
-
-#### Returns
-
-`void`
-
-***
-
-### pwd()
-
-> **pwd**(): `string`
-
-Defined in: [lib/zip.ts:329](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L329)
-
-获取当前目录，末尾不带 /
-
-#### Returns
-
-`string`
-
-string
-
-***
-
-### readDir()
-
-获取文件夹下文件列表
-
-#### Param
-
-文件夹路径
-
-#### Param
-
-选项
-
-#### Call Signature
-
-> **readDir**(`path?`, `opt?`): [`IZipItem`](../interfaces/IZipItem.md)[]
-
-Defined in: [lib/zip.ts:155](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L155)
-
-读取目录，hasChildren: false, hasDir: true, pathAsKey: false
-
-##### Parameters
-
-###### path?
-
-`string`
-
-###### opt?
-
-###### hasChildren?
-
-`boolean`
-
-###### hasDir?
-
-`boolean`
-
-###### pathAsKey?
-
-`false`
-
-##### Returns
-
-[`IZipItem`](../interfaces/IZipItem.md)[]
-
-#### Call Signature
-
-> **readDir**(`path?`, `opt?`): `Record`\<`string`, [`IZipItem`](../interfaces/IZipItem.md)\>
-
-Defined in: [lib/zip.ts:156](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L156)
-
-读取目录，hasChildren: false, hasDir: true, pathAsKey: false
-
-##### Parameters
-
-###### path?
-
-`string`
-
-###### opt?
-
-###### hasChildren?
-
-`boolean`
-
-###### hasDir?
-
-`boolean`
-
-###### pathAsKey
-
-`true`
-
-##### Returns
-
-`Record`\<`string`, [`IZipItem`](../interfaces/IZipItem.md)\>
-
-***
-
-### stats()
-
-> **stats**(`path`): [`IZipStats`](../interfaces/IZipStats.md) \| `null`
-
-Defined in: [lib/zip.ts:75](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L75)
-
-获取对象是否存在，存在则返回 stats 对象，否则返回 null
-
-#### Parameters
-
-##### path
-
-`string`
-
-对象路径
-
-#### Returns
-
-[`IZipStats`](../interfaces/IZipStats.md) \| `null`
-
-***
-
-### unlink()
-
-> **unlink**(`path`): `void`
-
-Defined in: [lib/zip.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L65)
-
-删除一个文件/文件夹（深度删除）
-
-#### Parameters
-
-##### path
-
-`string`
-
-要删除的文件路径
-
-#### Returns
-
-`void`

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

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/zip](../index.md) / get
-
-# Function: get()
-
-> **get**(`data?`): `Promise`\<[`Zip`](../classes/Zip.md) \| `null`\>
-
-Defined in: [lib/zip.ts:428](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L428)
-
-获取 zip 对象
-
-## Parameters
-
-### data?
-
-[`TZipInputFileFormat`](../type-aliases/TZipInputFileFormat.md)
-
-对象数据
-
-## Returns
-
-`Promise`\<[`Zip`](../classes/Zip.md) \| `null`\>