@maiyunnet/kebab 7.6.0 → 7.6.1

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

@@ -0,0 +1,107 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / IRproxyOptions
+
+# Interface: IRproxyOptions
+
+Defined in: [lib/net.ts:745](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L745)
+
+反向代理请求的传入参数选项
+
+## Properties
+
+### filter()?
+
+> `optional` **filter**: (`h`) => `boolean`
+
+Defined in: [lib/net.ts:754](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L754)
+
+过滤 header，返回 true 则留下
+
+#### Parameters
+
+##### h
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### follow?
+
+> `optional` **follow**: `number`
+
+Defined in: [lib/net.ts:748](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L748)
+
+***
+
+### headers?
+
+> `optional` **headers**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
+
+Defined in: [lib/net.ts:752](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L752)
+
+***
+
+### hosts?
+
+> `optional` **hosts**: `string` \| `Record`\<`string`, `string`\>
+
+Defined in: [lib/net.ts:750](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L750)
+
+自定义 host 映射，如 {'www.maiyun.net': '127.0.0.1'}，或全部映射到一个 host
+
+***
+
+### local?
+
+> `optional` **local**: `string`
+
+Defined in: [lib/net.ts:751](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L751)
+
+***
+
+### mproxy?
+
+> `optional` **mproxy**: `object`
+
+Defined in: [lib/net.ts:756](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L756)
+
+正向 mproxy 代理，url 如 https://xxx/abc
+
+#### auth
+
+> **auth**: `string`
+
+#### data?
+
+> `optional` **data**: `any`
+
+#### url
+
+> **url**: `string`
+
+***
+
+### reuse?
+
+> `optional` **reuse**: `string`
+
+Defined in: [lib/net.ts:762](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L762)
+
+默认为 default
+
+***
+
+### timeout?
+
+> `optional` **timeout**: `number`
+
+Defined in: [lib/net.ts:747](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L747)
+
+秒数

package/doc/sc/api/lib/net/request/classes/Request.md

@@ -0,0 +1,297 @@
+[**Documents for @maiyunnet/kebab**](../../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/net/request](../index.md) / Request
+
+# Class: Request
+
+Defined in: [lib/net/request.ts:10](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L10)
+
+## Constructors
+
+### Constructor
+
+> **new Request**(`url`): `Request`
+
+Defined in: [lib/net/request.ts:21](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L21)
+
+#### Parameters
+
+##### url
+
+`string`
+
+#### Returns
+
+`Request`
+
+## Methods
+
+### data()
+
+> **data**(`data`): `this`
+
+Defined in: [lib/net/request.ts:29](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L29)
+
+设置 get 或 post 的数据
+
+#### Parameters
+
+##### data
+
+数据
+
+`string` | `Record`\<`string`, `any`\> | `Buffer`\<`ArrayBufferLike`\> | `Readable`
+
+#### Returns
+
+`this`
+
+***
+
+### follow()
+
+> **follow**(`follow`): `this`
+
+Defined in: [lib/net/request.ts:86](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L86)
+
+设置是否跟随请求方的 location，留空为跟随，不设置为不跟随
+
+#### Parameters
+
+##### follow
+
+`number` = `5`
+
+#### Returns
+
+`this`
+
+***
+
+### get()
+
+> **get**(): `this`
+
+Defined in: [lib/net/request.ts:46](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L46)
+
+method get 方法别名
+
+#### Returns
+
+`this`
+
+***
+
+### headers()
+
+> **headers**(`headers`): `this`
+
+Defined in: [lib/net/request.ts:122](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L122)
+
+批量设置提交的 headers
+
+#### Parameters
+
+##### headers
+
+[`THttpHeaders`](../../type-aliases/THttpHeaders.md)
+
+#### Returns
+
+`this`
+
+***
+
+### hosts()
+
+> **hosts**(`hosts`): `this`
+
+Defined in: [lib/net/request.ts:95](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L95)
+
+设置域名 -> ip的对应键值，就像电脑里的 hosts 一样
+
+#### Parameters
+
+##### hosts
+
+`string` | `Record`\<`string`, `string`\>
+
+#### Returns
+
+`this`
+
+***
+
+### json()
+
+> **json**(): `this`
+
+Defined in: [lib/net/request.ts:69](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L69)
+
+type json 方法别名
+
+#### Returns
+
+`this`
+
+***
+
+### local()
+
+> **local**(`addr`): `this`
+
+Defined in: [lib/net/request.ts:113](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L113)
+
+设置使用的本地网卡 IP
+
+#### Parameters
+
+##### addr
+
+`string`
+
+#### Returns
+
+`this`
+
+***
+
+### method()
+
+> **method**(`method`): `this`
+
+Defined in: [lib/net/request.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L38)
+
+设置 get 或 post 请求
+
+#### Parameters
+
+##### method
+
+`"GET"` | `"POST"`
+
+#### Returns
+
+`this`
+
+***
+
+### post()
+
+> **post**(): `this`
+
+Defined in: [lib/net/request.ts:53](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L53)
+
+method post 方法别名
+
+#### Returns
+
+`this`
+
+***
+
+### request()
+
+> **request**(`cookie?`): `Promise`\<[`Response`](../../response/classes/Response.md)\>
+
+Defined in: [lib/net/request.ts:142](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L142)
+
+发起请求
+
+#### Parameters
+
+##### cookie?
+
+`Record`\<`string`, [`ICookie`](../../interfaces/ICookie.md)\>
+
+#### Returns
+
+`Promise`\<[`Response`](../../response/classes/Response.md)\>
+
+***
+
+### save()
+
+> **save**(`save`): `this`
+
+Defined in: [lib/net/request.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L104)
+
+设置后将直接保存到本地文件，不会返回，save 为本地实体路径
+
+#### Parameters
+
+##### save
+
+`string`
+
+#### Returns
+
+`this`
+
+***
+
+### setHeader()
+
+> **setHeader**(`name`, `val`): `this`
+
+Defined in: [lib/net/request.ts:132](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L132)
+
+设置单条 header
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### val
+
+`string`
+
+#### Returns
+
+`this`
+
+***
+
+### timeout()
+
+> **timeout**(`timeout`): `this`
+
+Defined in: [lib/net/request.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L77)
+
+设置请求有效期
+
+#### Parameters
+
+##### timeout
+
+`number`
+
+秒
+
+#### Returns
+
+`this`
+
+***
+
+### type()
+
+> **type**(`type`): `this`
+
+Defined in: [lib/net/request.ts:61](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L61)
+
+设置提交模式，json 还是普通 form
+
+#### Parameters
+
+##### type
+
+`"form"` | `"json"`
+
+#### Returns
+
+`this`

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

@@ -0,0 +1,11 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / lib/net/request
+
+# lib/net/request
+
+## Classes
+
+- [Request](classes/Request.md)

package/doc/sc/api/lib/net/response/classes/Response.md

@@ -0,0 +1,109 @@
+[**Documents for @maiyunnet/kebab**](../../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/net/response](../index.md) / Response
+
+# Class: Response
+
+Defined in: [lib/net/response.ts:10](https://github.com/maiyunnet/kebab/blob/master/lib/net/response.ts#L10)
+
+## Constructors
+
+### Constructor
+
+> **new Response**(`req`): `Response`
+
+Defined in: [lib/net/response.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/net/response.ts#L23)
+
+#### Parameters
+
+##### req
+
+`IResponse` | `null`
+
+#### Returns
+
+`Response`
+
+## Properties
+
+### error
+
+> **error**: `Error` \| `null` = `null`
+
+Defined in: [lib/net/response.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/net/response.ts#L18)
+
+***
+
+### headers
+
+> **headers**: [`THttpHeaders`](../../type-aliases/THttpHeaders.md) \| `null` = `null`
+
+Defined in: [lib/net/response.ts:16](https://github.com/maiyunnet/kebab/blob/master/lib/net/response.ts#L16)
+
+返回的 headers
+
+## Methods
+
+### getContent()
+
+> **getContent**(): `Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
+
+Defined in: [lib/net/response.ts:30](https://github.com/maiyunnet/kebab/blob/master/lib/net/response.ts#L30)
+
+读取所有内容到内存
+
+#### Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
+
+***
+
+### getRawStream()
+
+> **getRawStream**(): `Readable` \| `null`
+
+Defined in: [lib/net/response.ts:55](https://github.com/maiyunnet/kebab/blob/master/lib/net/response.ts#L55)
+
+获取原生响应读取流对象
+
+#### Returns
+
+`Readable` \| `null`
+
+***
+
+### getStream()
+
+> **getStream**(): `Readable` \| `null`
+
+Defined in: [lib/net/response.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/net/response.ts#L48)
+
+获取响应读取流对象
+
+#### Returns
+
+`Readable` \| `null`
+
+***
+
+### setContent()
+
+> **setContent**(`v`): `void`
+
+Defined in: [lib/net/response.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/net/response.ts#L41)
+
+用户自定义的 content 内容
+
+#### Parameters
+
+##### v
+
+内容值
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,11 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / lib/net/response
+
+# lib/net/response
+
+## Classes
+
+- [Response](classes/Response.md)

package/doc/sc/api/lib/net/type-aliases/THttpHeaders.md

@@ -0,0 +1,27 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / THttpHeaders
+
+# Type Alias: THttpHeaders
+
+> **THttpHeaders** = `http.IncomingHttpHeaders` & `object`
+
+Defined in: [lib/net.ts:767](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L767)
+
+http headers
+
+## Type Declaration
+
+### http-code?
+
+> `optional` **http-code**: `number`
+
+### http-url?
+
+> `optional` **http-url**: `string`
+
+### http-version?
+
+> `optional` **http-version**: `"1.1"` \| `"2.0"`