@maiyunnet/kebab 7.6.1 → 7.6.3

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

@@ -1,38 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / mproxy
-
-# Function: mproxy()
-
-> **mproxy**(`ctr`, `auth`, `opt`): `Promise`\<`number`\>
-
-Defined in: [lib/net.ts:583](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L583)
-
-正向 mproxy 代理，注意提前处理不要自动处理 post 数据，读取 get 的 url 为实际请求地址
-get: url, auth
-
-## Parameters
-
-### ctr
-
-[`Ctr`](../../../sys/ctr/classes/Ctr.md)
-
-当前控制器
-
-### auth
-
-`string`
-
-校验字符串，读取 get 的 auth 和本参数做比对
-
-### opt
-
-[`IMproxyOptions`](../interfaces/IMproxyOptions.md) = `{}`
-
-参数
-
-## Returns
-
-`Promise`\<`number`\>

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

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / mproxyData
-
-# Function: mproxyData()
-
-> **mproxyData**(`ctr`): `any`
-
-Defined in: [lib/net.ts:632](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L632)
-
-获取 mproxy 的附加数据
-
-## Parameters
-
-### ctr
-
-[`Ctr`](../../../sys/ctr/classes/Ctr.md)
-
-当前控制器
-
-## Returns
-
-`any`

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

@@ -1,23 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / open
-
-# Function: open()
-
-> **open**(`u`): [`Request`](../request/classes/Request.md)
-
-Defined in: [lib/net.ts:45](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L45)
-
-创建一个请求对象
-
-## Parameters
-
-### u
-
-`string`
-
-## Returns
-
-[`Request`](../request/classes/Request.md)

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

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / post
-
-# Function: post()
-
-> **post**(`u`, `data`, `opt`): `Promise`\<[`Response`](../response/classes/Response.md)\>
-
-Defined in: [lib/net.ts:64](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L64)
-
-发起一个 post 请求
-
-## Parameters
-
-### u
-
-`string`
-
-请求的 URL
-
-### data
-
-要发送的数据
-
-`string` | `Record`\<`string`, `any`\> | `Buffer`\<`ArrayBufferLike`\> | `Readable`
-
-### opt
-
-[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
-
-参数
-
-## Returns
-
-`Promise`\<[`Response`](../response/classes/Response.md)\>

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

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / postJson
-
-# Function: postJson()
-
-> **postJson**(`u`, `data`, `opt`): `Promise`\<[`Response`](../response/classes/Response.md)\>
-
-Defined in: [lib/net.ts:79](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L79)
-
-发起 JSON 请求
-
-## Parameters
-
-### u
-
-`string`
-
-网址
-
-### data
-
-数据
-
-`any`[] | `Record`\<`string`, `any`\>
-
-### opt
-
-[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
-
-选项
-
-## Returns
-
-`Promise`\<[`Response`](../response/classes/Response.md)\>

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

@@ -1,39 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / postJsonResponseJson
-
-# Function: postJsonResponseJson()
-
-> **postJsonResponseJson**(`u`, `data`, `opt`): `Promise`\<`any`\>
-
-Defined in: [lib/net.ts:96](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L96)
-
-发起 JSON 请求并解析 JSON 响应
-
-## Parameters
-
-### u
-
-`string`
-
-网址
-
-### data
-
-数据
-
-`any`[] | `Record`\<`string`, `any`\>
-
-### opt
-
-[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
-
-选项
-
-## Returns
-
-`Promise`\<`any`\>
-
-JSON 数据，失败时返回 null

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

@@ -1,33 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / request
-
-# Function: request()
-
-> **request**(`u`, `data?`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
-
-Defined in: [lib/net.ts:151](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L151)
-
-发起一个请求
-
-## Parameters
-
-### u
-
-`string`
-
-### data?
-
-`string` | `Record`\<`string`, `any`\> | `Buffer`\<`ArrayBufferLike`\> | `Readable`
-
-### opt?
-
-[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
-
-配置项
-
-## Returns
-
-`Promise`\<[`Response`](../response/classes/Response.md)\>

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

@@ -1,25 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / resetCookieSession
-
-# Function: resetCookieSession()
-
-> **resetCookieSession**(`cookie`): `void`
-
-Defined in: [lib/net.ts:519](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L519)
-
-模拟重启浏览器后的状态
-
-## Parameters
-
-### cookie
-
-`Record`\<`string`, [`ICookie`](../interfaces/ICookie.md)\>
-
-cookie 对象
-
-## Returns
-
-`void`

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

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / rproxy
-
-# Function: rproxy()
-
-> **rproxy**(`ctr`, `route`, `opt`): `Promise`\<`boolean`\>
-
-Defined in: [lib/net.ts:650](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L650)
-
-反向代理，注意提前处理不要自动处理 post 数据，将本服务器的某个路由反代到其他网址
-
-## Parameters
-
-### ctr
-
-[`Ctr`](../../../sys/ctr/classes/Ctr.md)
-
-当前控制器
-
-### route
-
-`Record`\<`string`, `string`\>
-
-要反代的路由
-
-### opt
-
-[`IRproxyOptions`](../interfaces/IRproxyOptions.md) = `{}`
-
-参数
-
-## Returns
-
-`Promise`\<`boolean`\>

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

@@ -1,63 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / setCookie
-
-# Function: setCookie()
-
-> **setCookie**(`cookie`, `name`, `value`, `domain`, `opt`): `void`
-
-Defined in: [lib/net.ts:331](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L331)
-
-对 cookie 对象进行操作
-
-## Parameters
-
-### cookie
-
-`Record`\<`string`, [`ICookie`](../interfaces/ICookie.md)\>
-
-要操作的对象
-
-### name
-
-`string`
-
-名
-
-### value
-
-`string`
-
-值
-
-### domain
-
-`string`
-
-应用网址，如 .xxx.com
-
-### opt
-
-选项 ttl, path, ssl, httponly
-
-#### httponly?
-
-`boolean`
-
-#### path?
-
-`string`
-
-#### ssl?
-
-`boolean`
-
-#### ttl?
-
-`number`
-
-## Returns
-
-`void`

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

@@ -1,37 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../index.md) / lib/net
-
-# lib/net
-
-## Interfaces
-
-- [ICookie](interfaces/ICookie.md)
-- [IMproxyOptions](interfaces/IMproxyOptions.md)
-- [IRequestOptions](interfaces/IRequestOptions.md)
-- [IRproxyOptions](interfaces/IRproxyOptions.md)
-
-## Type Aliases
-
-- [THttpHeaders](type-aliases/THttpHeaders.md)
-
-## Functions
-
-- [buildCookieQuery](functions/buildCookieQuery.md)
-- [fetch](functions/fetch.md)
-- [filterHeaders](functions/filterHeaders.md)
-- [get](functions/get.md)
-- [getCa](functions/getCa.md)
-- [getFormData](functions/getFormData.md)
-- [mproxy](functions/mproxy.md)
-- [mproxyData](functions/mproxyData.md)
-- [open](functions/open.md)
-- [post](functions/post.md)
-- [postJson](functions/postJson.md)
-- [postJsonResponseJson](functions/postJsonResponseJson.md)
-- [request](functions/request.md)
-- [resetCookieSession](functions/resetCookieSession.md)
-- [rproxy](functions/rproxy.md)
-- [setCookie](functions/setCookie.md)

package/doc/sc/api/lib/net/interfaces/ICookie.md

@@ -1,69 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / ICookie
-
-# Interface: ICookie
-
-Defined in: [lib/net.ts:775](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L775)
-
-Net Cookie 对象
-
-## Properties
-
-### domain
-
-> **domain**: `string`
-
-Defined in: [lib/net.ts:781](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L781)
-
-***
-
-### exp
-
-> **exp**: `number`
-
-Defined in: [lib/net.ts:779](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L779)
-
-有效期秒级时间戳
-
-***
-
-### httponly
-
-> **httponly**: `boolean`
-
-Defined in: [lib/net.ts:783](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L783)
-
-***
-
-### name
-
-> **name**: `string`
-
-Defined in: [lib/net.ts:776](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L776)
-
-***
-
-### path
-
-> **path**: `string`
-
-Defined in: [lib/net.ts:780](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L780)
-
-***
-
-### secure
-
-> **secure**: `boolean`
-
-Defined in: [lib/net.ts:782](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L782)
-
-***
-
-### value
-
-> **value**: `string`
-
-Defined in: [lib/net.ts:777](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L777)

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

@@ -1,85 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / IMproxyOptions
-
-# Interface: IMproxyOptions
-
-Defined in: [lib/net.ts:730](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L730)
-
-正向代理请求的传入参数选项
-
-## Properties
-
-### filter()?
-
-> `optional` **filter**: (`h`) => `boolean`
-
-Defined in: [lib/net.ts:739](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L739)
-
-过滤 header，返回 true 则留下
-
-#### Parameters
-
-##### h
-
-`string`
-
-#### Returns
-
-`boolean`
-
-***
-
-### follow?
-
-> `optional` **follow**: `number`
-
-Defined in: [lib/net.ts:733](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L733)
-
-***
-
-### headers?
-
-> `optional` **headers**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
-
-Defined in: [lib/net.ts:737](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L737)
-
-***
-
-### hosts?
-
-> `optional` **hosts**: `string` \| `Record`\<`string`, `string`\>
-
-Defined in: [lib/net.ts:735](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L735)
-
-自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host
-
-***
-
-### local?
-
-> `optional` **local**: `string`
-
-Defined in: [lib/net.ts:736](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L736)
-
-***
-
-### reuse?
-
-> `optional` **reuse**: `string`
-
-Defined in: [lib/net.ts:741](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L741)
-
-默认为 default
-
-***
-
-### timeout?
-
-> `optional` **timeout**: `number`
-
-Defined in: [lib/net.ts:732](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L732)
-
-秒数

package/doc/sc/api/lib/net/interfaces/IRequestOptions.md

@@ -1,133 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / IRequestOptions
-
-# Interface: IRequestOptions
-
-Defined in: [lib/net.ts:703](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L703)
-
-请求的传入参数选项
-
-## Properties
-
-### cookie?
-
-> `optional` **cookie**: `Record`\<`string`, [`ICookie`](ICookie.md)\>
-
-Defined in: [lib/net.ts:726](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L726)
-
-cookie 托管对象
-
-***
-
-### follow?
-
-> `optional` **follow**: `number`
-
-Defined in: [lib/net.ts:709](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L709)
-
-追踪 location 次数，0 为不追踪，默认为 0
-
-***
-
-### headers?
-
-> `optional` **headers**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
-
-Defined in: [lib/net.ts:714](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L714)
-
-***
-
-### hosts?
-
-> `optional` **hosts**: `string` \| `Record`\<`string`, `string`\>
-
-Defined in: [lib/net.ts:711](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L711)
-
-自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host
-
-***
-
-### keep?
-
-> `optional` **keep**: `boolean`
-
-Defined in: [lib/net.ts:722](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L722)
-
-连接是否保持长连接（即是否允许复用），默认为 true
-
-***
-
-### local?
-
-> `optional` **local**: `string`
-
-Defined in: [lib/net.ts:713](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L713)
-
-***
-
-### method?
-
-> `optional` **method**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"OPTIONS"`
-
-Defined in: [lib/net.ts:704](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L704)
-
-***
-
-### mproxy?
-
-> `optional` **mproxy**: `object`
-
-Defined in: [lib/net.ts:716](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L716)
-
-正向 mproxy 代理，url 如 https://xxx/abc
-
-#### auth
-
-> **auth**: `string`
-
-#### data?
-
-> `optional` **data**: `any`
-
-#### url
-
-> **url**: `string`
-
-***
-
-### reuse?
-
-> `optional` **reuse**: `string`
-
-Defined in: [lib/net.ts:724](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L724)
-
-复用池名，默认为 default
-
-***
-
-### save?
-
-> `optional` **save**: `string`
-
-Defined in: [lib/net.ts:712](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L712)
-
-***
-
-### timeout?
-
-> `optional` **timeout**: `number`
-
-Defined in: [lib/net.ts:707](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L707)
-
-秒数
-
-***
-
-### type?
-
-> `optional` **type**: `"form"` \| `"json"`
-
-Defined in: [lib/net.ts:705](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L705)