@maiyunnet/kebab 7.6.1 → 7.6.3

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

@@ -1,41 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/kv](../index.md) / get
-
-# Function: get()
-
-> **get**(`ctrEtc`, `oetc?`): [`Kv`](../classes/Kv.md)
-
-Defined in: [lib/kv.ts:956](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L956)
-
-获取 Kv 对象
-
-## Parameters
-
-### ctrEtc
-
-控制器或配置信息
-
-[`IConfigKv`](../../../index/interfaces/IConfigKv.md) | [`Ctr`](../../../sys/ctr/classes/Ctr.md)
-
-### oetc?
-
-可用来覆盖 ctr 的一些选项，如 index
-
-#### index?
-
-`number`
-
-#### pwd?
-
-`string`
-
-#### user?
-
-`string`
-
-## Returns
-
-[`Kv`](../classes/Kv.md)

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

@@ -1,20 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../index.md) / lib/kv
-
-# lib/kv
-
-## Classes
-
-- [Kv](classes/Kv.md)
-
-## Interfaces
-
-- [IConnectionInfo](interfaces/IConnectionInfo.md)
-- [IZRangeOptions](interfaces/IZRangeOptions.md)
-
-## Functions
-
-- [get](functions/get.md)

package/doc/sc/api/lib/kv/interfaces/IConnectionInfo.md

@@ -1,43 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/kv](../index.md) / IConnectionInfo
-
-# Interface: IConnectionInfo
-
-Defined in: [lib/kv.ts:972](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L972)
-
-连接信息
-
-## Properties
-
-### conn
-
-> **conn**: `ICommandClient`
-
-Defined in: [lib/kv.ts:976](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L976)
-
-***
-
-### host
-
-> **host**: `string`
-
-Defined in: [lib/kv.ts:973](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L973)
-
-***
-
-### index
-
-> **index**: `number`
-
-Defined in: [lib/kv.ts:975](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L975)
-
-***
-
-### port
-
-> **port**: `number`
-
-Defined in: [lib/kv.ts:974](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L974)

package/doc/sc/api/lib/kv/interfaces/IZRangeOptions.md

@@ -1,52 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/kv](../index.md) / IZRangeOptions
-
-# Interface: IZRangeOptions
-
-Defined in: [lib/kv.ts:15](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L15)
-
-## Properties
-
-### by?
-
-> `optional` **by**: `"SCORE"` \| `"LEX"`
-
-Defined in: [lib/kv.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L22)
-
-Range query type.
-
-- SCORE: Query by score range
-- LEX: Query by lexicographical range
-
-***
-
-### count?
-
-> `optional` **count**: `number`
-
-Defined in: [lib/kv.ts:37](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L37)
-
-Pagination count. Must be used together with offset.
-
-***
-
-### offset?
-
-> `optional` **offset**: `number`
-
-Defined in: [lib/kv.ts:32](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L32)
-
-Pagination offset. Must be used together with count.
-
-***
-
-### rev?
-
-> `optional` **rev**: `boolean`
-
-Defined in: [lib/kv.ts:27](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L27)
-
-Whether to return results in reverse order.

package/doc/sc/api/lib/lan/functions/card.md

@@ -1,17 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/lan](../index.md) / card
-
-# Function: card()
-
-> **card**(): `Promise`\<`object`[]\>
-
-Defined in: [lib/lan.ts:7](https://github.com/maiyunnet/kebab/blob/master/lib/lan.ts#L7)
-
-获取当前网卡的 IP、MAC 信息
-
-## Returns
-
-`Promise`\<`object`[]\>

package/doc/sc/api/lib/lan/functions/scan.md

@@ -1,17 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/lan](../index.md) / scan
-
-# Function: scan()
-
-> **scan**(): `Promise`\<`object`[]\>
-
-Defined in: [lib/lan.ts:63](https://github.com/maiyunnet/kebab/blob/master/lib/lan.ts#L63)
-
-扫描发生关联的局域网 IP
-
-## Returns
-
-`Promise`\<`object`[]\>

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

@@ -1,12 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../index.md) / lib/lan
-
-# lib/lan
-
-## Functions
-
-- [card](functions/card.md)
-- [scan](functions/scan.md)

package/doc/sc/api/lib/lang/functions/getCodeByAccept.md

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/lang](../index.md) / getCodeByAccept
-
-# Function: getCodeByAccept()
-
-> **getCodeByAccept**(`accept?`): `string`
-
-Defined in: [lib/lang.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/lang.ts#L36)
-
-根据常用语言字符串获取语言 code
-
-## Parameters
-
-### accept?
-
-`string`
-
-常用字符串，如 zh-cn，或包含 zh-cn 的字符串
-
-## Returns
-
-`string`

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

@@ -1,17 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../index.md) / lib/lang
-
-# lib/lang
-
-## Variables
-
-- [codes](variables/codes.md)
-- [map](variables/map.md)
-- [names](variables/names.md)
-
-## Functions
-
-- [getCodeByAccept](functions/getCodeByAccept.md)

package/doc/sc/api/lib/lang/variables/codes.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/lang](../index.md) / codes
-
-# Variable: codes
-
-> `const` **codes**: `string`[]
-
-Defined in: [lib/lang.ts:2](https://github.com/maiyunnet/kebab/blob/master/lib/lang.ts#L2)
-
-支持的语言缩写列表

package/doc/sc/api/lib/lang/variables/map.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/lang](../index.md) / map
-
-# Variable: map
-
-> `const` **map**: `Record`\<`string`, `string`\>
-
-Defined in: [lib/lang.ts:13](https://github.com/maiyunnet/kebab/blob/master/lib/lang.ts#L13)
-
-浏览器常用映射为本语言

package/doc/sc/api/lib/lang/variables/names.md

@@ -1,11 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/lang](../index.md) / names
-
-# Variable: names
-
-> `const` **names**: `string`[]
-
-Defined in: [lib/lang.ts:7](https://github.com/maiyunnet/kebab/blob/master/lib/lang.ts#L7)

package/doc/sc/api/lib/net/formdata/classes/FormData.md

@@ -1,157 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/net/formdata](../index.md) / FormData
-
-# Class: FormData
-
-Defined in: [lib/net/formdata.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L22)
-
-## Extends
-
-- `Readable`
-
-## Constructors
-
-### Constructor
-
-> **new FormData**(`opts?`): `FormData`
-
-Defined in: node\_modules/@types/node/stream.d.ts:163
-
-#### Parameters
-
-##### opts?
-
-`ReadableOptions`\<`Readable`\>
-
-#### Returns
-
-`FormData`
-
-#### Inherited from
-
-`stream.Readable.constructor`
-
-## Methods
-
-### \_read()
-
-> **\_read**(): `void`
-
-Defined in: [lib/net/formdata.ts:115](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L115)
-
-间隔读取（on data 或 pipe 触发）
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-`stream.Readable._read`
-
-***
-
-### getBoundary()
-
-> **getBoundary**(): `string`
-
-Defined in: [lib/net/formdata.ts:93](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L93)
-
-获取 boundary
-
-#### Returns
-
-`string`
-
-***
-
-### getLength()
-
-> **getLength**(): `number`
-
-Defined in: [lib/net/formdata.ts:100](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L100)
-
-获取总字节长度
-
-#### Returns
-
-`number`
-
-***
-
-### getSent()
-
-> **getSent**(): `number`
-
-Defined in: [lib/net/formdata.ts:107](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L107)
-
-获取已发送的字节长度
-
-#### Returns
-
-`number`
-
-***
-
-### putFile()
-
-> **putFile**(`key`, `path`, `fname?`): `Promise`\<`boolean`\>
-
-Defined in: [lib/net/formdata.ts:67](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L67)
-
-添加文件
-
-#### Parameters
-
-##### key
-
-`string`
-
-键
-
-##### path
-
-`string`
-
-路径
-
-##### fname?
-
-`string`
-
-可选，文件名
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-***
-
-### putString()
-
-> **putString**(`key`, `val`): `void`
-
-Defined in: [lib/net/formdata.ts:50](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L50)
-
-添加字符串
-
-#### Parameters
-
-##### key
-
-`string`
-
-键
-
-##### val
-
-`string`
-
-值
-
-#### Returns
-
-`void`

package/doc/sc/api/lib/net/formdata/index.md

@@ -1,15 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / lib/net/formdata
-
-# lib/net/formdata
-
-## Classes
-
-- [FormData](classes/FormData.md)
-
-## Interfaces
-
-- [IItem](interfaces/IItem.md)

package/doc/sc/api/lib/net/formdata/interfaces/IItem.md

@@ -1,55 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/net/formdata](../index.md) / IItem
-
-# Interface: IItem
-
-Defined in: [lib/net/formdata.ts:12](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L12)
-
-Item 对象
-
-## Properties
-
-### isFile
-
-> **isFile**: `boolean`
-
-Defined in: [lib/net/formdata.ts:15](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L15)
-
-***
-
-### isString
-
-> **isString**: `boolean`
-
-Defined in: [lib/net/formdata.ts:16](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L16)
-
-***
-
-### key
-
-> **key**: `string`
-
-Defined in: [lib/net/formdata.ts:14](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L14)
-
-key 键
-
-***
-
-### path
-
-> **path**: `string`
-
-Defined in: [lib/net/formdata.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L19)
-
-***
-
-### value
-
-> **value**: `string`
-
-Defined in: [lib/net/formdata.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L18)
-
-值或者文件名

package/doc/sc/api/lib/net/functions/buildCookieQuery.md

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / buildCookieQuery
-
-# Function: buildCookieQuery()
-
-> **buildCookieQuery**(`cookie`, `uri`): `string`
-
-Defined in: [lib/net.ts:469](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L469)
-
-对象转换为 Cookie 拼接字符串（会自动筛掉不能发送的 cookie）
-
-## Parameters
-
-### cookie
-
-`Record`\<`string`, [`ICookie`](../interfaces/ICookie.md)\>
-
-cookie 对象
-
-### uri
-
-[`IUrlParse`](../../../index/interfaces/IUrlParse.md)
-
-请求的 URI 对象
-
-## Returns
-
-`string`

package/doc/sc/api/lib/net/functions/fetch.md

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / fetch
-
-# Function: fetch()
-
-> **fetch**(`input`, `init`): `Promise`\<`Response`\>
-
-Defined in: [lib/net.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L118)
-
-发起一个原生 fetch 请求，增加了一些框架选项，注意：会抛出错误
-
-## Parameters
-
-### input
-
-请求的 URL 或 Request 对象
-
-`string` | `Request` | `URL`
-
-### init
-
-`RequestInit` & `object` = `{}`
-
-增加 mproxy
-
-## Returns
-
-`Promise`\<`Response`\>

package/doc/sc/api/lib/net/functions/filterHeaders.md

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / filterHeaders
-
-# Function: filterHeaders()
-
-> **filterHeaders**(`headers`, `res?`, `filter?`): `Record`\<`string`, `string` \| `string`[]\>
-
-Defined in: [lib/net.ts:547](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L547)
-
-剔除不代理的 header，返回新的 header
-
-## Parameters
-
-### headers
-
-剔除前的 header
-
-`IncomingHttpHeaders` | `IncomingHttpHeaders` | [`THttpHeaders`](../type-aliases/THttpHeaders.md)
-
-### res?
-
-直接设置头部而不返回，可置空
-
-`Http2ServerResponse`\<`Http2ServerRequest`\> | `ServerResponse`\<`IncomingMessage`\>
-
-### filter?
-
-(`h`) => `boolean`
-
-返回 true 则留下
-
-## Returns
-
-`Record`\<`string`, `string` \| `string`[]\>

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

@@ -1,31 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / get
-
-# Function: get()
-
-> **get**(`u`, `opt`): `Promise`\<[`Response`](../response/classes/Response.md)\>
-
-Defined in: [lib/net.ts:54](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L54)
-
-发起一个 get 请求
-
-## Parameters
-
-### u
-
-`string`
-
-请求的 URL
-
-### opt
-
-[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
-
-参数
-
-## Returns
-
-`Promise`\<[`Response`](../response/classes/Response.md)\>

package/doc/sc/api/lib/net/functions/getCa.md

@@ -1,17 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / getCa
-
-# Function: getCa()
-
-> **getCa**(): `Promise`\<`string`\>
-
-Defined in: [lib/net.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L28)
-
-获取 CA 证书
-
-## Returns
-
-`Promise`\<`string`\>

package/doc/sc/api/lib/net/functions/getFormData.md

@@ -1,17 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / getFormData
-
-# Function: getFormData()
-
-> **getFormData**(): [`FormData`](../formdata/classes/FormData.md)
-
-Defined in: [lib/net.ts:531](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L531)
-
-创建 FormData 对象
-
-## Returns
-
-[`FormData`](../formdata/classes/FormData.md)