@maiyunnet/kebab 9.1.3 → 9.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/doc/kebab-rag.md +2237 -437
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/lib/buffer.d.ts +5 -0
- package/lib/buffer.js +13 -0
- package/lib/cookie.d.ts +44 -0
- package/lib/cookie.js +216 -0
- package/lib/core.d.ts +3 -2
- package/lib/core.js +15 -12
- package/lib/dns.d.ts +1 -1
- package/lib/dns.js +4 -6
- package/lib/net/request.d.ts +2 -1
- package/lib/net.d.ts +3 -38
- package/lib/net.js +6 -219
- package/lib/socket.d.ts +4 -3
- package/lib/turnstile.js +2 -2
- package/lib/undici/formdata.d.ts +83 -0
- package/lib/undici/formdata.js +166 -0
- package/lib/undici/request.d.ts +86 -0
- package/lib/undici/request.js +120 -0
- package/lib/undici/response.d.ts +39 -0
- package/lib/undici/response.js +111 -0
- package/lib/undici.d.ts +174 -0
- package/lib/undici.js +595 -0
- package/lib/ws.d.ts +6 -5
- package/lib/ws.js +9 -9
- package/package.json +3 -2
- package/sys/cmd.js +4 -1
- package/sys/route.js +5 -2
- package/www/example/ctr/middle.js +3 -2
- package/www/example/ctr/test.d.ts +32 -0
- package/www/example/ctr/test.js +526 -4
- package/www/example/route.json +1 -0
package/doc/kebab-rag.md
CHANGED
|
@@ -1100,6 +1100,7 @@ index.md
|
|
|
1100
1100
|
- [lib/buffer](lib/buffer/index.md)
|
|
1101
1101
|
- [lib/captcha](lib/captcha/index.md)
|
|
1102
1102
|
- [lib/consistent](lib/consistent/index.md)
|
|
1103
|
+
- [lib/cookie](lib/cookie/index.md)
|
|
1103
1104
|
- [lib/core](lib/core/index.md)
|
|
1104
1105
|
- [lib/cron](lib/cron/index.md)
|
|
1105
1106
|
- [lib/crypto](lib/crypto/index.md)
|
|
@@ -1128,6 +1129,10 @@ index.md
|
|
|
1128
1129
|
- [lib/text](lib/text/index.md)
|
|
1129
1130
|
- [lib/time](lib/time/index.md)
|
|
1130
1131
|
- [lib/turnstile](lib/turnstile/index.md)
|
|
1132
|
+
- [lib/undici](lib/undici/index.md)
|
|
1133
|
+
- [lib/undici/formdata](lib/undici/formdata/index.md)
|
|
1134
|
+
- [lib/undici/request](lib/undici/request/index.md)
|
|
1135
|
+
- [lib/undici/response](lib/undici/response/index.md)
|
|
1131
1136
|
- [lib/vector](lib/vector/index.md)
|
|
1132
1137
|
- [lib/ws](lib/ws/index.md)
|
|
1133
1138
|
- [lib/zip](lib/zip/index.md)
|
|
@@ -1355,7 +1360,7 @@ index/variables/VER.md
|
|
|
1355
1360
|
|
|
1356
1361
|
# Variable: VER
|
|
1357
1362
|
|
|
1358
|
-
> `const` **VER**: `"9.
|
|
1363
|
+
> `const` **VER**: `"9.2.0"` = `'9.2.0'`
|
|
1359
1364
|
|
|
1360
1365
|
Defined in: [index.ts:10](https://github.com/maiyunnet/kebab/blob/master/index.ts#L10)
|
|
1361
1366
|
|
|
@@ -1943,7 +1948,7 @@ lib/buffer/classes/Reader.md
|
|
|
1943
1948
|
|
|
1944
1949
|
# Class: Reader
|
|
1945
1950
|
|
|
1946
|
-
Defined in: [lib/buffer.ts:
|
|
1951
|
+
Defined in: [lib/buffer.ts:4](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L4)
|
|
1947
1952
|
|
|
1948
1953
|
读对象
|
|
1949
1954
|
|
|
@@ -1953,7 +1958,7 @@ Defined in: [lib/buffer.ts:2](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
1953
1958
|
|
|
1954
1959
|
> **new Reader**(`buffer`): `Reader`
|
|
1955
1960
|
|
|
1956
|
-
Defined in: [lib/buffer.ts:
|
|
1961
|
+
Defined in: [lib/buffer.ts:11](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L11)
|
|
1957
1962
|
|
|
1958
1963
|
#### Parameters
|
|
1959
1964
|
|
|
@@ -1971,7 +1976,7 @@ Defined in: [lib/buffer.ts:9](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
1971
1976
|
|
|
1972
1977
|
> **length**(): `number`
|
|
1973
1978
|
|
|
1974
|
-
Defined in: [lib/buffer.ts:
|
|
1979
|
+
Defined in: [lib/buffer.ts:78](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L78)
|
|
1975
1980
|
|
|
1976
1981
|
获取完整的 buffer 长度
|
|
1977
1982
|
|
|
@@ -1985,7 +1990,7 @@ Defined in: [lib/buffer.ts:76](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
1985
1990
|
|
|
1986
1991
|
> **readBCDString**(`length?`): `string`
|
|
1987
1992
|
|
|
1988
|
-
Defined in: [lib/buffer.ts:
|
|
1993
|
+
Defined in: [lib/buffer.ts:51](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L51)
|
|
1989
1994
|
|
|
1990
1995
|
读取一个 BCD 编码的字符串(每个字节表示两个数字)
|
|
1991
1996
|
|
|
@@ -2005,7 +2010,7 @@ Defined in: [lib/buffer.ts:49](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
2005
2010
|
|
|
2006
2011
|
> **readBuffer**(`length?`): `Buffer`
|
|
2007
2012
|
|
|
2008
|
-
Defined in: [lib/buffer.ts:
|
|
2013
|
+
Defined in: [lib/buffer.ts:72](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L72)
|
|
2009
2014
|
|
|
2010
2015
|
读取 Buffer
|
|
2011
2016
|
|
|
@@ -2025,7 +2030,7 @@ Defined in: [lib/buffer.ts:70](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
2025
2030
|
|
|
2026
2031
|
> **readString**(`length?`, `encoding?`): `string`
|
|
2027
2032
|
|
|
2028
|
-
Defined in: [lib/buffer.ts:
|
|
2033
|
+
Defined in: [lib/buffer.ts:64](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L64)
|
|
2029
2034
|
|
|
2030
2035
|
读取普通 string
|
|
2031
2036
|
|
|
@@ -2049,7 +2054,7 @@ Defined in: [lib/buffer.ts:62](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
2049
2054
|
|
|
2050
2055
|
> **readUInt16BE**(): `number`
|
|
2051
2056
|
|
|
2052
|
-
Defined in: [lib/buffer.ts:
|
|
2057
|
+
Defined in: [lib/buffer.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L23)
|
|
2053
2058
|
|
|
2054
2059
|
读取一个无符号 16 位整数(大端模式),WORD
|
|
2055
2060
|
|
|
@@ -2063,7 +2068,7 @@ Defined in: [lib/buffer.ts:21](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
2063
2068
|
|
|
2064
2069
|
> **readUInt16LE**(): `number`
|
|
2065
2070
|
|
|
2066
|
-
Defined in: [lib/buffer.ts:
|
|
2071
|
+
Defined in: [lib/buffer.ts:30](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L30)
|
|
2067
2072
|
|
|
2068
2073
|
读取一个无符号 16 位整数(小端模式)
|
|
2069
2074
|
|
|
@@ -2077,7 +2082,7 @@ Defined in: [lib/buffer.ts:28](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
2077
2082
|
|
|
2078
2083
|
> **readUInt32BE**(): `number`
|
|
2079
2084
|
|
|
2080
|
-
Defined in: [lib/buffer.ts:
|
|
2085
|
+
Defined in: [lib/buffer.ts:37](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L37)
|
|
2081
2086
|
|
|
2082
2087
|
读取一个无符号 32 位整数(大端模式), DWORD
|
|
2083
2088
|
|
|
@@ -2091,7 +2096,7 @@ Defined in: [lib/buffer.ts:35](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
2091
2096
|
|
|
2092
2097
|
> **readUInt32LE**(): `number`
|
|
2093
2098
|
|
|
2094
|
-
Defined in: [lib/buffer.ts:
|
|
2099
|
+
Defined in: [lib/buffer.ts:44](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L44)
|
|
2095
2100
|
|
|
2096
2101
|
读取一个无符号 32 位整数(小端模式)
|
|
2097
2102
|
|
|
@@ -2105,7 +2110,7 @@ Defined in: [lib/buffer.ts:42](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
2105
2110
|
|
|
2106
2111
|
> **readUInt8**(): `number`
|
|
2107
2112
|
|
|
2108
|
-
Defined in: [lib/buffer.ts:
|
|
2113
|
+
Defined in: [lib/buffer.ts:16](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L16)
|
|
2109
2114
|
|
|
2110
2115
|
读取一个无符号 8 位整数, BYTE
|
|
2111
2116
|
|
|
@@ -2124,7 +2129,7 @@ lib/buffer/classes/Writer.md
|
|
|
2124
2129
|
|
|
2125
2130
|
# Class: Writer
|
|
2126
2131
|
|
|
2127
|
-
Defined in: [lib/buffer.ts:
|
|
2132
|
+
Defined in: [lib/buffer.ts:85](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L85)
|
|
2128
2133
|
|
|
2129
2134
|
写对象
|
|
2130
2135
|
|
|
@@ -2134,7 +2139,7 @@ Defined in: [lib/buffer.ts:83](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
2134
2139
|
|
|
2135
2140
|
> **new Writer**(`size`): `Writer`
|
|
2136
2141
|
|
|
2137
|
-
Defined in: [lib/buffer.ts:
|
|
2142
|
+
Defined in: [lib/buffer.ts:92](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L92)
|
|
2138
2143
|
|
|
2139
2144
|
#### Parameters
|
|
2140
2145
|
|
|
@@ -2152,7 +2157,7 @@ Defined in: [lib/buffer.ts:90](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
2152
2157
|
|
|
2153
2158
|
> **get**(): `Buffer`
|
|
2154
2159
|
|
|
2155
|
-
Defined in: [lib/buffer.ts:
|
|
2160
|
+
Defined in: [lib/buffer.ts:135](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L135)
|
|
2156
2161
|
|
|
2157
2162
|
返回 Buffer 对象
|
|
2158
2163
|
|
|
@@ -2166,7 +2171,7 @@ Defined in: [lib/buffer.ts:133](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
2166
2171
|
|
|
2167
2172
|
> **writeBCDString**(`value`): `void`
|
|
2168
2173
|
|
|
2169
|
-
Defined in: [lib/buffer.ts:
|
|
2174
|
+
Defined in: [lib/buffer.ts:115](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L115)
|
|
2170
2175
|
|
|
2171
2176
|
[每字节 2 数字] 写入一个 BCD 编码的字符串(仅支持数字)
|
|
2172
2177
|
|
|
@@ -2186,7 +2191,7 @@ Defined in: [lib/buffer.ts:113](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
2186
2191
|
|
|
2187
2192
|
> **writeString**(`value`, `encoding?`): `number`
|
|
2188
2193
|
|
|
2189
|
-
Defined in: [lib/buffer.ts:
|
|
2194
|
+
Defined in: [lib/buffer.ts:128](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L128)
|
|
2190
2195
|
|
|
2191
2196
|
写入普通字符串,返回写入的长度
|
|
2192
2197
|
|
|
@@ -2210,7 +2215,7 @@ Defined in: [lib/buffer.ts:126](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
2210
2215
|
|
|
2211
2216
|
> **writeUInt16BE**(`value`): `void`
|
|
2212
2217
|
|
|
2213
|
-
Defined in: [lib/buffer.ts:
|
|
2218
|
+
Defined in: [lib/buffer.ts:103](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L103)
|
|
2214
2219
|
|
|
2215
2220
|
[2 字节] 写入一个无符号 16 位整数(大端模式)
|
|
2216
2221
|
|
|
@@ -2230,7 +2235,7 @@ Defined in: [lib/buffer.ts:101](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
2230
2235
|
|
|
2231
2236
|
> **writeUInt32BE**(`value`): `void`
|
|
2232
2237
|
|
|
2233
|
-
Defined in: [lib/buffer.ts:
|
|
2238
|
+
Defined in: [lib/buffer.ts:109](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L109)
|
|
2234
2239
|
|
|
2235
2240
|
[4 字节] 写入一个无符号 32 位整数(大端模式)
|
|
2236
2241
|
|
|
@@ -2250,7 +2255,7 @@ Defined in: [lib/buffer.ts:107](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
2250
2255
|
|
|
2251
2256
|
> **writeUInt8**(`value`): `void`
|
|
2252
2257
|
|
|
2253
|
-
Defined in: [lib/buffer.ts:
|
|
2258
|
+
Defined in: [lib/buffer.ts:97](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L97)
|
|
2254
2259
|
|
|
2255
2260
|
[1 字节] 写入一个无符号 8 位整数
|
|
2256
2261
|
|
|
@@ -2264,6 +2269,35 @@ Defined in: [lib/buffer.ts:95](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
2264
2269
|
|
|
2265
2270
|
`void`
|
|
2266
2271
|
|
|
2272
|
+
lib/buffer/functions/getFull.md
|
|
2273
|
+
---
|
|
2274
|
+
|
|
2275
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
2276
|
+
|
|
2277
|
+
***
|
|
2278
|
+
|
|
2279
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/buffer](../index.md) / getFull
|
|
2280
|
+
|
|
2281
|
+
# Function: getFull()
|
|
2282
|
+
|
|
2283
|
+
> **getFull**(`stream`): `Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
|
|
2284
|
+
|
|
2285
|
+
Defined in: [lib/buffer.ts:161](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L161)
|
|
2286
|
+
|
|
2287
|
+
从可读流中获取完整的 Buffer
|
|
2288
|
+
|
|
2289
|
+
## Parameters
|
|
2290
|
+
|
|
2291
|
+
### stream
|
|
2292
|
+
|
|
2293
|
+
`ReadableStream`
|
|
2294
|
+
|
|
2295
|
+
可读流对象
|
|
2296
|
+
|
|
2297
|
+
## Returns
|
|
2298
|
+
|
|
2299
|
+
`Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
|
|
2300
|
+
|
|
2267
2301
|
lib/buffer/functions/getReader.md
|
|
2268
2302
|
---
|
|
2269
2303
|
|
|
@@ -2277,7 +2311,7 @@ lib/buffer/functions/getReader.md
|
|
|
2277
2311
|
|
|
2278
2312
|
> **getReader**(`buffer`): [`Reader`](../classes/Reader.md)
|
|
2279
2313
|
|
|
2280
|
-
Defined in: [lib/buffer.ts:
|
|
2314
|
+
Defined in: [lib/buffer.ts:145](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L145)
|
|
2281
2315
|
|
|
2282
2316
|
Buffer Reader 对象
|
|
2283
2317
|
|
|
@@ -2306,7 +2340,7 @@ lib/buffer/functions/getWriter.md
|
|
|
2306
2340
|
|
|
2307
2341
|
> **getWriter**(`size`): [`Writer`](../classes/Writer.md)
|
|
2308
2342
|
|
|
2309
|
-
Defined in: [lib/buffer.ts:
|
|
2343
|
+
Defined in: [lib/buffer.ts:153](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L153)
|
|
2310
2344
|
|
|
2311
2345
|
Buffer Writer 对象
|
|
2312
2346
|
|
|
@@ -2340,6 +2374,7 @@ lib/buffer/index.md
|
|
|
2340
2374
|
|
|
2341
2375
|
## Functions
|
|
2342
2376
|
|
|
2377
|
+
- [getFull](functions/getFull.md)
|
|
2343
2378
|
- [getReader](functions/getReader.md)
|
|
2344
2379
|
- [getWriter](functions/getWriter.md)
|
|
2345
2380
|
|
|
@@ -2867,6 +2902,273 @@ lib/consistent/index.md
|
|
|
2867
2902
|
- [getRange](functions/getRange.md)
|
|
2868
2903
|
- [hash](functions/hash.md)
|
|
2869
2904
|
|
|
2905
|
+
lib/cookie/functions/buildCookieObject.md
|
|
2906
|
+
---
|
|
2907
|
+
|
|
2908
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
2909
|
+
|
|
2910
|
+
***
|
|
2911
|
+
|
|
2912
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/cookie](../index.md) / buildCookieObject
|
|
2913
|
+
|
|
2914
|
+
# Function: buildCookieObject()
|
|
2915
|
+
|
|
2916
|
+
> **buildCookieObject**(`cookie`, `setCookies`, `uri`): `Promise`\<`void`\>
|
|
2917
|
+
|
|
2918
|
+
Defined in: [lib/cookie.ts:46](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L46)
|
|
2919
|
+
|
|
2920
|
+
根据 Set-Cookie 头部转换到 cookie 对象
|
|
2921
|
+
|
|
2922
|
+
## Parameters
|
|
2923
|
+
|
|
2924
|
+
### cookie
|
|
2925
|
+
|
|
2926
|
+
`Record`\<`string`, [`ICookie`](../interfaces/ICookie.md)\>
|
|
2927
|
+
|
|
2928
|
+
cookie 对象
|
|
2929
|
+
|
|
2930
|
+
### setCookies
|
|
2931
|
+
|
|
2932
|
+
`string`[]
|
|
2933
|
+
|
|
2934
|
+
头部的 set-cookie 数组
|
|
2935
|
+
|
|
2936
|
+
### uri
|
|
2937
|
+
|
|
2938
|
+
[`IUrlParse`](../../../index/interfaces/IUrlParse.md)
|
|
2939
|
+
|
|
2940
|
+
请求的 URI 对象
|
|
2941
|
+
|
|
2942
|
+
## Returns
|
|
2943
|
+
|
|
2944
|
+
`Promise`\<`void`\>
|
|
2945
|
+
|
|
2946
|
+
lib/cookie/functions/buildCookieQuery.md
|
|
2947
|
+
---
|
|
2948
|
+
|
|
2949
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
2950
|
+
|
|
2951
|
+
***
|
|
2952
|
+
|
|
2953
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/cookie](../index.md) / buildCookieQuery
|
|
2954
|
+
|
|
2955
|
+
# Function: buildCookieQuery()
|
|
2956
|
+
|
|
2957
|
+
> **buildCookieQuery**(`cookie`, `uri`): `string`
|
|
2958
|
+
|
|
2959
|
+
Defined in: [lib/cookie.ts:175](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L175)
|
|
2960
|
+
|
|
2961
|
+
对象转换为 Cookie 拼接字符串(会自动筛掉不能发送的 cookie)
|
|
2962
|
+
|
|
2963
|
+
## Parameters
|
|
2964
|
+
|
|
2965
|
+
### cookie
|
|
2966
|
+
|
|
2967
|
+
`Record`\<`string`, [`ICookie`](../interfaces/ICookie.md)\>
|
|
2968
|
+
|
|
2969
|
+
cookie 对象
|
|
2970
|
+
|
|
2971
|
+
### uri
|
|
2972
|
+
|
|
2973
|
+
[`IUrlParse`](../../../index/interfaces/IUrlParse.md)
|
|
2974
|
+
|
|
2975
|
+
请求的 URI 对象
|
|
2976
|
+
|
|
2977
|
+
## Returns
|
|
2978
|
+
|
|
2979
|
+
`string`
|
|
2980
|
+
|
|
2981
|
+
lib/cookie/functions/resetCookieSession.md
|
|
2982
|
+
---
|
|
2983
|
+
|
|
2984
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
2985
|
+
|
|
2986
|
+
***
|
|
2987
|
+
|
|
2988
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/cookie](../index.md) / resetCookieSession
|
|
2989
|
+
|
|
2990
|
+
# Function: resetCookieSession()
|
|
2991
|
+
|
|
2992
|
+
> **resetCookieSession**(`cookie`): `void`
|
|
2993
|
+
|
|
2994
|
+
Defined in: [lib/cookie.ts:225](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L225)
|
|
2995
|
+
|
|
2996
|
+
模拟重启浏览器后的状态
|
|
2997
|
+
|
|
2998
|
+
## Parameters
|
|
2999
|
+
|
|
3000
|
+
### cookie
|
|
3001
|
+
|
|
3002
|
+
`Record`\<`string`, [`ICookie`](../interfaces/ICookie.md)\>
|
|
3003
|
+
|
|
3004
|
+
cookie 对象
|
|
3005
|
+
|
|
3006
|
+
## Returns
|
|
3007
|
+
|
|
3008
|
+
`void`
|
|
3009
|
+
|
|
3010
|
+
lib/cookie/functions/setCookie.md
|
|
3011
|
+
---
|
|
3012
|
+
|
|
3013
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
3014
|
+
|
|
3015
|
+
***
|
|
3016
|
+
|
|
3017
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/cookie](../index.md) / setCookie
|
|
3018
|
+
|
|
3019
|
+
# Function: setCookie()
|
|
3020
|
+
|
|
3021
|
+
> **setCookie**(`cookie`, `name`, `value`, `domain`, `opt?`): `void`
|
|
3022
|
+
|
|
3023
|
+
Defined in: [lib/cookie.ts:13](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L13)
|
|
3024
|
+
|
|
3025
|
+
对 cookie 对象进行操作
|
|
3026
|
+
|
|
3027
|
+
## Parameters
|
|
3028
|
+
|
|
3029
|
+
### cookie
|
|
3030
|
+
|
|
3031
|
+
`Record`\<`string`, [`ICookie`](../interfaces/ICookie.md)\>
|
|
3032
|
+
|
|
3033
|
+
要操作的对象
|
|
3034
|
+
|
|
3035
|
+
### name
|
|
3036
|
+
|
|
3037
|
+
`string`
|
|
3038
|
+
|
|
3039
|
+
名
|
|
3040
|
+
|
|
3041
|
+
### value
|
|
3042
|
+
|
|
3043
|
+
`string`
|
|
3044
|
+
|
|
3045
|
+
值
|
|
3046
|
+
|
|
3047
|
+
### domain
|
|
3048
|
+
|
|
3049
|
+
`string`
|
|
3050
|
+
|
|
3051
|
+
应用网址,如 .xxx.com
|
|
3052
|
+
|
|
3053
|
+
### opt?
|
|
3054
|
+
|
|
3055
|
+
选项 ttl, path, ssl, httponly
|
|
3056
|
+
|
|
3057
|
+
#### httponly?
|
|
3058
|
+
|
|
3059
|
+
`boolean`
|
|
3060
|
+
|
|
3061
|
+
#### path?
|
|
3062
|
+
|
|
3063
|
+
`string`
|
|
3064
|
+
|
|
3065
|
+
#### ssl?
|
|
3066
|
+
|
|
3067
|
+
`boolean`
|
|
3068
|
+
|
|
3069
|
+
#### ttl?
|
|
3070
|
+
|
|
3071
|
+
`number`
|
|
3072
|
+
|
|
3073
|
+
## Returns
|
|
3074
|
+
|
|
3075
|
+
`void`
|
|
3076
|
+
|
|
3077
|
+
lib/cookie/index.md
|
|
3078
|
+
---
|
|
3079
|
+
|
|
3080
|
+
[**Documents for @maiyunnet/kebab**](../../index.md)
|
|
3081
|
+
|
|
3082
|
+
***
|
|
3083
|
+
|
|
3084
|
+
[Documents for @maiyunnet/kebab](../../index.md) / lib/cookie
|
|
3085
|
+
|
|
3086
|
+
# lib/cookie
|
|
3087
|
+
|
|
3088
|
+
## Interfaces
|
|
3089
|
+
|
|
3090
|
+
- [ICookie](interfaces/ICookie.md)
|
|
3091
|
+
|
|
3092
|
+
## Functions
|
|
3093
|
+
|
|
3094
|
+
- [buildCookieObject](functions/buildCookieObject.md)
|
|
3095
|
+
- [buildCookieQuery](functions/buildCookieQuery.md)
|
|
3096
|
+
- [resetCookieSession](functions/resetCookieSession.md)
|
|
3097
|
+
- [setCookie](functions/setCookie.md)
|
|
3098
|
+
|
|
3099
|
+
lib/cookie/interfaces/ICookie.md
|
|
3100
|
+
---
|
|
3101
|
+
|
|
3102
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
3103
|
+
|
|
3104
|
+
***
|
|
3105
|
+
|
|
3106
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/cookie](../index.md) / ICookie
|
|
3107
|
+
|
|
3108
|
+
# Interface: ICookie
|
|
3109
|
+
|
|
3110
|
+
Defined in: [lib/cookie.ts:237](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L237)
|
|
3111
|
+
|
|
3112
|
+
Cookie 对象
|
|
3113
|
+
|
|
3114
|
+
## Properties
|
|
3115
|
+
|
|
3116
|
+
### domain
|
|
3117
|
+
|
|
3118
|
+
> **domain**: `string`
|
|
3119
|
+
|
|
3120
|
+
Defined in: [lib/cookie.ts:243](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L243)
|
|
3121
|
+
|
|
3122
|
+
***
|
|
3123
|
+
|
|
3124
|
+
### exp
|
|
3125
|
+
|
|
3126
|
+
> **exp**: `number`
|
|
3127
|
+
|
|
3128
|
+
Defined in: [lib/cookie.ts:241](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L241)
|
|
3129
|
+
|
|
3130
|
+
有效期秒级时间戳
|
|
3131
|
+
|
|
3132
|
+
***
|
|
3133
|
+
|
|
3134
|
+
### httponly
|
|
3135
|
+
|
|
3136
|
+
> **httponly**: `boolean`
|
|
3137
|
+
|
|
3138
|
+
Defined in: [lib/cookie.ts:245](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L245)
|
|
3139
|
+
|
|
3140
|
+
***
|
|
3141
|
+
|
|
3142
|
+
### name
|
|
3143
|
+
|
|
3144
|
+
> **name**: `string`
|
|
3145
|
+
|
|
3146
|
+
Defined in: [lib/cookie.ts:238](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L238)
|
|
3147
|
+
|
|
3148
|
+
***
|
|
3149
|
+
|
|
3150
|
+
### path
|
|
3151
|
+
|
|
3152
|
+
> **path**: `string`
|
|
3153
|
+
|
|
3154
|
+
Defined in: [lib/cookie.ts:242](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L242)
|
|
3155
|
+
|
|
3156
|
+
***
|
|
3157
|
+
|
|
3158
|
+
### secure
|
|
3159
|
+
|
|
3160
|
+
> **secure**: `boolean`
|
|
3161
|
+
|
|
3162
|
+
Defined in: [lib/cookie.ts:244](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L244)
|
|
3163
|
+
|
|
3164
|
+
***
|
|
3165
|
+
|
|
3166
|
+
### value
|
|
3167
|
+
|
|
3168
|
+
> **value**: `string`
|
|
3169
|
+
|
|
3170
|
+
Defined in: [lib/cookie.ts:239](https://github.com/maiyunnet/kebab/blob/master/lib/cookie.ts#L239)
|
|
3171
|
+
|
|
2870
3172
|
lib/core/functions/checkSchema.md
|
|
2871
3173
|
---
|
|
2872
3174
|
|
|
@@ -2880,7 +3182,7 @@ lib/core/functions/checkSchema.md
|
|
|
2880
3182
|
|
|
2881
3183
|
> **checkSchema**(`val`, `schema`): `string`
|
|
2882
3184
|
|
|
2883
|
-
Defined in: [lib/core.ts:
|
|
3185
|
+
Defined in: [lib/core.ts:301](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L301)
|
|
2884
3186
|
|
|
2885
3187
|
判断一个对象是否符合 JSON Schema
|
|
2886
3188
|
|
|
@@ -2915,7 +3217,7 @@ lib/core/functions/checkType.md
|
|
|
2915
3217
|
|
|
2916
3218
|
> **checkType**(`val`, `type`, `tree?`): `string`
|
|
2917
3219
|
|
|
2918
|
-
Defined in: [lib/core.ts:
|
|
3220
|
+
Defined in: [lib/core.ts:213](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L213)
|
|
2919
3221
|
|
|
2920
3222
|
判断一个对象是否符合示例组,返回空字符串代表校验通过,返回:应该的类型:位置:传入的类型
|
|
2921
3223
|
|
|
@@ -2956,7 +3258,7 @@ lib/core/functions/clone.md
|
|
|
2956
3258
|
|
|
2957
3259
|
> **clone**\<`T`\>(`obj`): `T`
|
|
2958
3260
|
|
|
2959
|
-
Defined in: [lib/core.ts:
|
|
3261
|
+
Defined in: [lib/core.ts:1006](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1006)
|
|
2960
3262
|
|
|
2961
3263
|
完整的克隆一份数组/对象
|
|
2962
3264
|
|
|
@@ -2991,7 +3293,7 @@ lib/core/functions/convert62.md
|
|
|
2991
3293
|
|
|
2992
3294
|
> **convert62**(`n`): `string`
|
|
2993
3295
|
|
|
2994
|
-
Defined in: [lib/core.ts:
|
|
3296
|
+
Defined in: [lib/core.ts:154](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L154)
|
|
2995
3297
|
|
|
2996
3298
|
将 10 进制转换为 62 进制
|
|
2997
3299
|
|
|
@@ -3020,7 +3322,7 @@ lib/core/functions/debug.md
|
|
|
3020
3322
|
|
|
3021
3323
|
> **debug**(`message?`, ...`optionalParams`): `void`
|
|
3022
3324
|
|
|
3023
|
-
Defined in: [lib/core.ts:
|
|
3325
|
+
Defined in: [lib/core.ts:1040](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1040)
|
|
3024
3326
|
|
|
3025
3327
|
打印调试信息,线上环境不会打印
|
|
3026
3328
|
|
|
@@ -3055,7 +3357,7 @@ lib/core/functions/display.md
|
|
|
3055
3357
|
|
|
3056
3358
|
> **display**(`message?`, ...`optionalParams`): `void`
|
|
3057
3359
|
|
|
3058
|
-
Defined in: [lib/core.ts:
|
|
3360
|
+
Defined in: [lib/core.ts:1053](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1053)
|
|
3059
3361
|
|
|
3060
3362
|
向控制台直接显示内容,一般情况下禁止使用
|
|
3061
3363
|
|
|
@@ -3090,7 +3392,7 @@ lib/core/functions/emptyObject.md
|
|
|
3090
3392
|
|
|
3091
3393
|
> **emptyObject**(`obj`, `deep?`): `void`
|
|
3092
3394
|
|
|
3093
|
-
Defined in: [lib/core.ts:
|
|
3395
|
+
Defined in: [lib/core.ts:439](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L439)
|
|
3094
3396
|
|
|
3095
3397
|
将对象的所有属性清除包括键,不会破坏引用关系,对象变量依然保证是引用状态
|
|
3096
3398
|
|
|
@@ -3125,7 +3427,7 @@ lib/core/functions/exec.md
|
|
|
3125
3427
|
|
|
3126
3428
|
> **exec**(`command`, `options?`): `Promise`\<`string` \| `false`\>
|
|
3127
3429
|
|
|
3128
|
-
Defined in: [lib/core.ts:
|
|
3430
|
+
Defined in: [lib/core.ts:501](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L501)
|
|
3129
3431
|
|
|
3130
3432
|
执行命令行
|
|
3131
3433
|
|
|
@@ -3160,7 +3462,7 @@ lib/core/functions/getLog.md
|
|
|
3160
3462
|
|
|
3161
3463
|
> **getLog**(`opt`): `Promise`\<`false` \| `string`[][] \| `null`\>
|
|
3162
3464
|
|
|
3163
|
-
Defined in: [lib/core.ts:
|
|
3465
|
+
Defined in: [lib/core.ts:913](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L913)
|
|
3164
3466
|
|
|
3165
3467
|
获取日志内容为一个数组
|
|
3166
3468
|
|
|
@@ -3235,7 +3537,7 @@ lib/core/functions/ip.md
|
|
|
3235
3537
|
|
|
3236
3538
|
> **ip**(`ctr`, `req?`): `string`
|
|
3237
3539
|
|
|
3238
|
-
Defined in: [lib/core.ts:
|
|
3540
|
+
Defined in: [lib/core.ts:358](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L358)
|
|
3239
3541
|
|
|
3240
3542
|
获取 IP(非安全 IP)
|
|
3241
3543
|
|
|
@@ -3266,7 +3568,7 @@ lib/core/functions/loadEnv.md
|
|
|
3266
3568
|
|
|
3267
3569
|
> **loadEnv**(`dir`): `Promise`\<`void`\>
|
|
3268
3570
|
|
|
3269
|
-
Defined in: [lib/core.ts:
|
|
3571
|
+
Defined in: [lib/core.ts:1105](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1105)
|
|
3270
3572
|
|
|
3271
3573
|
加载 .env 文件到 process.env,若文件不存在则跳过
|
|
3272
3574
|
|
|
@@ -3295,7 +3597,7 @@ lib/core/functions/log.md
|
|
|
3295
3597
|
|
|
3296
3598
|
> **log**(`opt`, `msg`, `fend?`): `void`
|
|
3297
3599
|
|
|
3298
|
-
Defined in: [lib/core.ts:
|
|
3600
|
+
Defined in: [lib/core.ts:807](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L807)
|
|
3299
3601
|
|
|
3300
3602
|
写入文件日志
|
|
3301
3603
|
|
|
@@ -3336,7 +3638,7 @@ lib/core/functions/ls.md
|
|
|
3336
3638
|
|
|
3337
3639
|
> **ls**(`opt`): `Promise`\<`object`[]\>
|
|
3338
3640
|
|
|
3339
|
-
Defined in: [lib/core.ts:
|
|
3641
|
+
Defined in: [lib/core.ts:967](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L967)
|
|
3340
3642
|
|
|
3341
3643
|
获取目录内文件/文件夹列表
|
|
3342
3644
|
|
|
@@ -3379,7 +3681,7 @@ lib/core/functions/muid.md
|
|
|
3379
3681
|
|
|
3380
3682
|
> **muid**(`ctr`, `opt?`): `string`
|
|
3381
3683
|
|
|
3382
|
-
Defined in: [lib/core.ts:
|
|
3684
|
+
Defined in: [lib/core.ts:318](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L318)
|
|
3383
3685
|
|
|
3384
3686
|
获取 MUID
|
|
3385
3687
|
|
|
@@ -3442,7 +3744,7 @@ lib/core/functions/objectSort.md
|
|
|
3442
3744
|
|
|
3443
3745
|
> **objectSort**\<`T`\>(`o`): `T`
|
|
3444
3746
|
|
|
3445
|
-
Defined in: [lib/core.ts:
|
|
3747
|
+
Defined in: [lib/core.ts:420](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L420)
|
|
3446
3748
|
|
|
3447
3749
|
将对象进行升序排列
|
|
3448
3750
|
|
|
@@ -3477,7 +3779,7 @@ lib/core/functions/passThroughAppend.md
|
|
|
3477
3779
|
|
|
3478
3780
|
> **passThroughAppend**(`passThrough`, `data`, `end?`): `Promise`\<`void`\>
|
|
3479
3781
|
|
|
3480
|
-
Defined in: [lib/core.ts:
|
|
3782
|
+
Defined in: [lib/core.ts:458](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L458)
|
|
3481
3783
|
|
|
3482
3784
|
调用前自行创建 passThrough,并且调用 pipe 绑定到应该绑定的对象,然后再调用本函数
|
|
3483
3785
|
|
|
@@ -3491,7 +3793,7 @@ passThrough 对象
|
|
|
3491
3793
|
|
|
3492
3794
|
### data
|
|
3493
3795
|
|
|
3494
|
-
(`string` \| `Buffer`\<`ArrayBufferLike`\> \| `Readable` \| [`Response`](../../net/response/classes/Response.md))[]
|
|
3796
|
+
(`string` \| `Buffer`\<`ArrayBufferLike`\> \| `Readable` \| [`Response`](../../undici/response/classes/Response.md) \| [`Response`](../../net/response/classes/Response.md))[]
|
|
3495
3797
|
|
|
3496
3798
|
数组
|
|
3497
3799
|
|
|
@@ -3518,7 +3820,7 @@ lib/core/functions/purify.md
|
|
|
3518
3820
|
|
|
3519
3821
|
> **purify**(`text`): `string`
|
|
3520
3822
|
|
|
3521
|
-
Defined in: [lib/core.ts:
|
|
3823
|
+
Defined in: [lib/core.ts:183](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L183)
|
|
3522
3824
|
|
|
3523
3825
|
去除 html 的空白符、换行以及注释
|
|
3524
3826
|
|
|
@@ -3547,7 +3849,7 @@ lib/core/functions/rand.md
|
|
|
3547
3849
|
|
|
3548
3850
|
> **rand**(`min`, `max`, `prec?`): `number`
|
|
3549
3851
|
|
|
3550
|
-
Defined in: [lib/core.ts:
|
|
3852
|
+
Defined in: [lib/core.ts:91](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L91)
|
|
3551
3853
|
|
|
3552
3854
|
生成基础的范围随机数
|
|
3553
3855
|
|
|
@@ -3588,7 +3890,7 @@ lib/core/functions/random.md
|
|
|
3588
3890
|
|
|
3589
3891
|
> **random**(`length?`, `source?`, `block?`): `string`
|
|
3590
3892
|
|
|
3591
|
-
Defined in: [lib/core.ts:
|
|
3893
|
+
Defined in: [lib/core.ts:129](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L129)
|
|
3592
3894
|
|
|
3593
3895
|
生成随机字符串
|
|
3594
3896
|
|
|
@@ -3629,7 +3931,7 @@ lib/core/functions/realIP.md
|
|
|
3629
3931
|
|
|
3630
3932
|
> **realIP**(`ctr`, `name?`): `string`
|
|
3631
3933
|
|
|
3632
|
-
Defined in: [lib/core.ts:
|
|
3934
|
+
Defined in: [lib/core.ts:392](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L392)
|
|
3633
3935
|
|
|
3634
3936
|
获取直连 IP(安全 IP)
|
|
3635
3937
|
|
|
@@ -3662,7 +3964,7 @@ lib/core/functions/removeGlobal.md
|
|
|
3662
3964
|
|
|
3663
3965
|
> **removeGlobal**(`key`, `hosts?`): `Promise`\<`string`[]\>
|
|
3664
3966
|
|
|
3665
|
-
Defined in: [lib/core.ts:
|
|
3967
|
+
Defined in: [lib/core.ts:730](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L730)
|
|
3666
3968
|
|
|
3667
3969
|
移除某个跨线程/跨内网服务器全局变量
|
|
3668
3970
|
|
|
@@ -3697,7 +3999,7 @@ lib/core/functions/resolveEnvVars.md
|
|
|
3697
3999
|
|
|
3698
4000
|
> **resolveEnvVars**(`obj`): `void`
|
|
3699
4001
|
|
|
3700
|
-
Defined in: [lib/core.ts:
|
|
4002
|
+
Defined in: [lib/core.ts:1135](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1135)
|
|
3701
4003
|
|
|
3702
4004
|
将配置对象中的 ${ENV_VAR} 占位符替换为 process.env 的值
|
|
3703
4005
|
|
|
@@ -3726,7 +4028,7 @@ lib/core/functions/sendNpm.md
|
|
|
3726
4028
|
|
|
3727
4029
|
> **sendNpm**(`path`, `hosts?`): `Promise`\<`string`[]\>
|
|
3728
4030
|
|
|
3729
|
-
Defined in: [lib/core.ts:
|
|
4031
|
+
Defined in: [lib/core.ts:646](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L646)
|
|
3730
4032
|
|
|
3731
4033
|
向本机或局域网 RPC 发送 npm install 操作
|
|
3732
4034
|
|
|
@@ -3761,7 +4063,7 @@ lib/core/functions/sendPm2.md
|
|
|
3761
4063
|
|
|
3762
4064
|
> **sendPm2**(`name`, `action?`, `hosts?`): `Promise`\<`string`[]\>
|
|
3763
4065
|
|
|
3764
|
-
Defined in: [lib/core.ts:
|
|
4066
|
+
Defined in: [lib/core.ts:606](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L606)
|
|
3765
4067
|
|
|
3766
4068
|
向本机或局域网 RPC 发送 PM2 操作
|
|
3767
4069
|
|
|
@@ -3802,7 +4104,7 @@ lib/core/functions/sendReload.md
|
|
|
3802
4104
|
|
|
3803
4105
|
> **sendReload**(`hosts?`): `Promise`\<`string`[]\>
|
|
3804
4106
|
|
|
3805
|
-
Defined in: [lib/core.ts:
|
|
4107
|
+
Defined in: [lib/core.ts:521](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L521)
|
|
3806
4108
|
|
|
3807
4109
|
向主进程(或局域网同代码机子)发送广播将进行 reload 操作,等待回传
|
|
3808
4110
|
主要作用除代码热更新以外的其他情况
|
|
@@ -3830,7 +4132,7 @@ lib/core/functions/sendRestart.md
|
|
|
3830
4132
|
|
|
3831
4133
|
> **sendRestart**(`hosts?`): `Promise`\<`string`[]\>
|
|
3832
4134
|
|
|
3833
|
-
Defined in: [lib/core.ts:
|
|
4135
|
+
Defined in: [lib/core.ts:561](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L561)
|
|
3834
4136
|
|
|
3835
4137
|
向主进程(或局域网同代码机子)发送广播将进行 restart 操作,停止监听并启动新进程,老进程在连接全部断开后自行销毁
|
|
3836
4138
|
主要用作不间断的代码热更新
|
|
@@ -3858,7 +4160,7 @@ lib/core/functions/setCookie.md
|
|
|
3858
4160
|
|
|
3859
4161
|
> **setCookie**(`ctr`, `name`, `value`, `opt?`): `void`
|
|
3860
4162
|
|
|
3861
|
-
Defined in: [lib/core.ts:
|
|
4163
|
+
Defined in: [lib/core.ts:62](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L62)
|
|
3862
4164
|
|
|
3863
4165
|
设置 cookie
|
|
3864
4166
|
|
|
@@ -3905,7 +4207,7 @@ lib/core/functions/setGlobal.md
|
|
|
3905
4207
|
|
|
3906
4208
|
> **setGlobal**(`key`, `data`, `hosts?`): `Promise`\<`string`[]\>
|
|
3907
4209
|
|
|
3908
|
-
Defined in: [lib/core.ts:
|
|
4210
|
+
Defined in: [lib/core.ts:689](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L689)
|
|
3909
4211
|
|
|
3910
4212
|
设置跨线程/指定的局域网主机的全局变量
|
|
3911
4213
|
|
|
@@ -3946,7 +4248,7 @@ lib/core/functions/sleep.md
|
|
|
3946
4248
|
|
|
3947
4249
|
> **sleep**(`ms`): `Promise`\<`void`\>
|
|
3948
4250
|
|
|
3949
|
-
Defined in: [lib/core.ts:
|
|
4251
|
+
Defined in: [lib/core.ts:408](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L408)
|
|
3950
4252
|
|
|
3951
4253
|
间隔一段时间
|
|
3952
4254
|
|
|
@@ -3975,7 +4277,7 @@ lib/core/functions/unconvert62.md
|
|
|
3975
4277
|
|
|
3976
4278
|
> **unconvert62**(`n`): `bigint`
|
|
3977
4279
|
|
|
3978
|
-
Defined in: [lib/core.ts:
|
|
4280
|
+
Defined in: [lib/core.ts:170](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L170)
|
|
3979
4281
|
|
|
3980
4282
|
将 62 进制转换为 10 进制
|
|
3981
4283
|
|
|
@@ -4004,7 +4306,7 @@ lib/core/functions/updateCode.md
|
|
|
4004
4306
|
|
|
4005
4307
|
> **updateCode**(`sourcePath`, `path`, `hosts?`, `config?`, `strict?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4006
4308
|
|
|
4007
|
-
Defined in: [lib/core.ts:
|
|
4309
|
+
Defined in: [lib/core.ts:742](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L742)
|
|
4008
4310
|
|
|
4009
4311
|
上传并覆盖代码文件,config.json、kebab.json、.js.map、.ts, .gitignore 不会被覆盖和新创建
|
|
4010
4312
|
|
|
@@ -4057,7 +4359,7 @@ lib/core/functions/writeEventStreamHead.md
|
|
|
4057
4359
|
|
|
4058
4360
|
> **writeEventStreamHead**(`res`): `void`
|
|
4059
4361
|
|
|
4060
|
-
Defined in: [lib/core.ts:
|
|
4362
|
+
Defined in: [lib/core.ts:1075](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1075)
|
|
4061
4363
|
|
|
4062
4364
|
## Parameters
|
|
4063
4365
|
|
|
@@ -4082,7 +4384,7 @@ lib/core/functions/writeHead.md
|
|
|
4082
4384
|
|
|
4083
4385
|
> **writeHead**(`res`, `statusCode`, `headers?`): `void`
|
|
4084
4386
|
|
|
4085
|
-
Defined in: [lib/core.ts:
|
|
4387
|
+
Defined in: [lib/core.ts:1064](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1064)
|
|
4086
4388
|
|
|
4087
4389
|
让 res 发送头部(前提是头部没有被发送才能调用本方法
|
|
4088
4390
|
|
|
@@ -4123,7 +4425,7 @@ lib/core/functions/write.md
|
|
|
4123
4425
|
|
|
4124
4426
|
> **write**(`res`, `data`): `void`
|
|
4125
4427
|
|
|
4126
|
-
Defined in: [lib/core.ts:
|
|
4428
|
+
Defined in: [lib/core.ts:1087](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1087)
|
|
4127
4429
|
|
|
4128
4430
|
向 res 发送数据
|
|
4129
4431
|
|
|
@@ -4229,7 +4531,7 @@ lib/core/interfaces/ICookieOptions.md
|
|
|
4229
4531
|
|
|
4230
4532
|
# Interface: ICookieOptions
|
|
4231
4533
|
|
|
4232
|
-
Defined in: [lib/core.ts:
|
|
4534
|
+
Defined in: [lib/core.ts:46](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L46)
|
|
4233
4535
|
|
|
4234
4536
|
Cookie 设置的选项
|
|
4235
4537
|
|
|
@@ -4239,7 +4541,7 @@ Cookie 设置的选项
|
|
|
4239
4541
|
|
|
4240
4542
|
> `optional` **domain?**: `string`
|
|
4241
4543
|
|
|
4242
|
-
Defined in: [lib/core.ts:
|
|
4544
|
+
Defined in: [lib/core.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L49)
|
|
4243
4545
|
|
|
4244
4546
|
***
|
|
4245
4547
|
|
|
@@ -4247,7 +4549,7 @@ Defined in: [lib/core.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4247
4549
|
|
|
4248
4550
|
> `optional` **httponly?**: `boolean`
|
|
4249
4551
|
|
|
4250
|
-
Defined in: [lib/core.ts:
|
|
4552
|
+
Defined in: [lib/core.ts:51](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L51)
|
|
4251
4553
|
|
|
4252
4554
|
***
|
|
4253
4555
|
|
|
@@ -4255,7 +4557,7 @@ Defined in: [lib/core.ts:50](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4255
4557
|
|
|
4256
4558
|
> `optional` **path?**: `string`
|
|
4257
4559
|
|
|
4258
|
-
Defined in: [lib/core.ts:
|
|
4560
|
+
Defined in: [lib/core.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L48)
|
|
4259
4561
|
|
|
4260
4562
|
***
|
|
4261
4563
|
|
|
@@ -4263,7 +4565,7 @@ Defined in: [lib/core.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4263
4565
|
|
|
4264
4566
|
> `optional` **samesite?**: `"Strict"` \| `"Lax"` \| `"None"`
|
|
4265
4567
|
|
|
4266
|
-
Defined in: [lib/core.ts:
|
|
4568
|
+
Defined in: [lib/core.ts:52](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L52)
|
|
4267
4569
|
|
|
4268
4570
|
***
|
|
4269
4571
|
|
|
@@ -4271,7 +4573,7 @@ Defined in: [lib/core.ts:51](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4271
4573
|
|
|
4272
4574
|
> `optional` **ssl?**: `boolean`
|
|
4273
4575
|
|
|
4274
|
-
Defined in: [lib/core.ts:
|
|
4576
|
+
Defined in: [lib/core.ts:50](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L50)
|
|
4275
4577
|
|
|
4276
4578
|
***
|
|
4277
4579
|
|
|
@@ -4279,7 +4581,7 @@ Defined in: [lib/core.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4279
4581
|
|
|
4280
4582
|
> `optional` **ttl?**: `number`
|
|
4281
4583
|
|
|
4282
|
-
Defined in: [lib/core.ts:
|
|
4584
|
+
Defined in: [lib/core.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L47)
|
|
4283
4585
|
|
|
4284
4586
|
lib/core/interfaces/ILogOptions.md
|
|
4285
4587
|
---
|
|
@@ -4292,7 +4594,7 @@ lib/core/interfaces/ILogOptions.md
|
|
|
4292
4594
|
|
|
4293
4595
|
# Interface: ILogOptions
|
|
4294
4596
|
|
|
4295
|
-
Defined in: [lib/core.ts:
|
|
4597
|
+
Defined in: [lib/core.ts:790](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L790)
|
|
4296
4598
|
|
|
4297
4599
|
log 设置的选项
|
|
4298
4600
|
|
|
@@ -4302,7 +4604,7 @@ log 设置的选项
|
|
|
4302
4604
|
|
|
4303
4605
|
> `optional` **cookie?**: `Record`\<`string`, `string`\>
|
|
4304
4606
|
|
|
4305
|
-
Defined in: [lib/core.ts:
|
|
4607
|
+
Defined in: [lib/core.ts:796](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L796)
|
|
4306
4608
|
|
|
4307
4609
|
***
|
|
4308
4610
|
|
|
@@ -4310,7 +4612,7 @@ Defined in: [lib/core.ts:791](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4310
4612
|
|
|
4311
4613
|
> `optional` **get?**: `Record`\<`string`, `any`\>
|
|
4312
4614
|
|
|
4313
|
-
Defined in: [lib/core.ts:
|
|
4615
|
+
Defined in: [lib/core.ts:795](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L795)
|
|
4314
4616
|
|
|
4315
4617
|
***
|
|
4316
4618
|
|
|
@@ -4318,7 +4620,7 @@ Defined in: [lib/core.ts:790](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4318
4620
|
|
|
4319
4621
|
> `optional` **headers?**: `IncomingHttpHeaders`
|
|
4320
4622
|
|
|
4321
|
-
Defined in: [lib/core.ts:
|
|
4623
|
+
Defined in: [lib/core.ts:798](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L798)
|
|
4322
4624
|
|
|
4323
4625
|
***
|
|
4324
4626
|
|
|
@@ -4326,7 +4628,7 @@ Defined in: [lib/core.ts:793](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4326
4628
|
|
|
4327
4629
|
> `optional` **hostname?**: `string`
|
|
4328
4630
|
|
|
4329
|
-
Defined in: [lib/core.ts:
|
|
4631
|
+
Defined in: [lib/core.ts:793](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L793)
|
|
4330
4632
|
|
|
4331
4633
|
***
|
|
4332
4634
|
|
|
@@ -4334,7 +4636,7 @@ Defined in: [lib/core.ts:788](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4334
4636
|
|
|
4335
4637
|
> `optional` **path?**: `string`
|
|
4336
4638
|
|
|
4337
|
-
Defined in: [lib/core.ts:
|
|
4639
|
+
Defined in: [lib/core.ts:791](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L791)
|
|
4338
4640
|
|
|
4339
4641
|
***
|
|
4340
4642
|
|
|
@@ -4342,7 +4644,7 @@ Defined in: [lib/core.ts:786](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4342
4644
|
|
|
4343
4645
|
> `optional` **req?**: `IncomingMessage` \| `Http2ServerRequest` \| `null`
|
|
4344
4646
|
|
|
4345
|
-
Defined in: [lib/core.ts:
|
|
4647
|
+
Defined in: [lib/core.ts:794](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L794)
|
|
4346
4648
|
|
|
4347
4649
|
***
|
|
4348
4650
|
|
|
@@ -4350,7 +4652,7 @@ Defined in: [lib/core.ts:789](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4350
4652
|
|
|
4351
4653
|
> `optional` **session?**: `Record`\<`string`, `any`\>
|
|
4352
4654
|
|
|
4353
|
-
Defined in: [lib/core.ts:
|
|
4655
|
+
Defined in: [lib/core.ts:797](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L797)
|
|
4354
4656
|
|
|
4355
4657
|
***
|
|
4356
4658
|
|
|
@@ -4358,7 +4660,7 @@ Defined in: [lib/core.ts:792](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4358
4660
|
|
|
4359
4661
|
> `optional` **urlFull?**: `string`
|
|
4360
4662
|
|
|
4361
|
-
Defined in: [lib/core.ts:
|
|
4663
|
+
Defined in: [lib/core.ts:792](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L792)
|
|
4362
4664
|
|
|
4363
4665
|
lib/core/type-aliases/TPm2Action.md
|
|
4364
4666
|
---
|
|
@@ -4373,7 +4675,7 @@ lib/core/type-aliases/TPm2Action.md
|
|
|
4373
4675
|
|
|
4374
4676
|
> **TPm2Action** = `"start"` \| `"stop"` \| `"restart"`
|
|
4375
4677
|
|
|
4376
|
-
Defined in: [lib/core.ts:
|
|
4678
|
+
Defined in: [lib/core.ts:598](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L598)
|
|
4377
4679
|
|
|
4378
4680
|
PM2 操作类型
|
|
4379
4681
|
|
|
@@ -4390,7 +4692,7 @@ lib/core/variables/globalConfig.md
|
|
|
4390
4692
|
|
|
4391
4693
|
> `const` **globalConfig**: [`IConfig`](../../../index/interfaces/IConfig.md) & `object`
|
|
4392
4694
|
|
|
4393
|
-
Defined in: [lib/core.ts:
|
|
4695
|
+
Defined in: [lib/core.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L25)
|
|
4394
4696
|
|
|
4395
4697
|
全局参数
|
|
4396
4698
|
|
|
@@ -4447,7 +4749,7 @@ lib/core/variables/global.md
|
|
|
4447
4749
|
|
|
4448
4750
|
> `const` **global**: `Record`\<`string`, `any`\> = `{}`
|
|
4449
4751
|
|
|
4450
|
-
Defined in: [lib/core.ts:
|
|
4752
|
+
Defined in: [lib/core.ts:681](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L681)
|
|
4451
4753
|
|
|
4452
4754
|
跨进程全局变量
|
|
4453
4755
|
|
|
@@ -4464,7 +4766,7 @@ lib/core/variables/RANDOM_L.md
|
|
|
4464
4766
|
|
|
4465
4767
|
> `const` **RANDOM\_L**: `"abcdefghijklmnopqrstuvwxyz"` = `'abcdefghijklmnopqrstuvwxyz'`
|
|
4466
4768
|
|
|
4467
|
-
Defined in: [lib/core.ts:
|
|
4769
|
+
Defined in: [lib/core.ts:108](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L108)
|
|
4468
4770
|
|
|
4469
4771
|
小写字母字符集
|
|
4470
4772
|
|
|
@@ -4481,7 +4783,7 @@ lib/core/variables/RANDOM_LN.md
|
|
|
4481
4783
|
|
|
4482
4784
|
> `const` **RANDOM\_LN**: `string`
|
|
4483
4785
|
|
|
4484
|
-
Defined in: [lib/core.ts:
|
|
4786
|
+
Defined in: [lib/core.ts:113](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L113)
|
|
4485
4787
|
|
|
4486
4788
|
小写字母 + 数字字符集
|
|
4487
4789
|
|
|
@@ -4498,7 +4800,7 @@ lib/core/variables/RANDOM_LU.md
|
|
|
4498
4800
|
|
|
4499
4801
|
> `const` **RANDOM\_LU**: `string`
|
|
4500
4802
|
|
|
4501
|
-
Defined in: [lib/core.ts:
|
|
4803
|
+
Defined in: [lib/core.ts:115](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L115)
|
|
4502
4804
|
|
|
4503
4805
|
小写字母 + 大写字母字符集
|
|
4504
4806
|
|
|
@@ -4515,7 +4817,7 @@ lib/core/variables/RANDOM_LUN.md
|
|
|
4515
4817
|
|
|
4516
4818
|
> `const` **RANDOM\_LUN**: `string`
|
|
4517
4819
|
|
|
4518
|
-
Defined in: [lib/core.ts:
|
|
4820
|
+
Defined in: [lib/core.ts:117](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L117)
|
|
4519
4821
|
|
|
4520
4822
|
小写字母 + 大写字母 + 数字字符集
|
|
4521
4823
|
|
|
@@ -4532,7 +4834,7 @@ lib/core/variables/RANDOM_LUNS.md
|
|
|
4532
4834
|
|
|
4533
4835
|
> `const` **RANDOM\_LUNS**: `string`
|
|
4534
4836
|
|
|
4535
|
-
Defined in: [lib/core.ts:
|
|
4837
|
+
Defined in: [lib/core.ts:121](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L121)
|
|
4536
4838
|
|
|
4537
4839
|
小写字母 + 大写字母 + 数字字符集 + 特殊字符字符集
|
|
4538
4840
|
|
|
@@ -4549,7 +4851,7 @@ lib/core/variables/RANDOM_N.md
|
|
|
4549
4851
|
|
|
4550
4852
|
> `const` **RANDOM\_N**: `"0123456789"` = `'0123456789'`
|
|
4551
4853
|
|
|
4552
|
-
Defined in: [lib/core.ts:
|
|
4854
|
+
Defined in: [lib/core.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L104)
|
|
4553
4855
|
|
|
4554
4856
|
数字字符集
|
|
4555
4857
|
|
|
@@ -4566,7 +4868,7 @@ lib/core/variables/RANDOM_U.md
|
|
|
4566
4868
|
|
|
4567
4869
|
> `const` **RANDOM\_U**: `"ABCDEFGHIJKLMNOPQRSTUVWXYZ"` = `'ABCDEFGHIJKLMNOPQRSTUVWXYZ'`
|
|
4568
4870
|
|
|
4569
|
-
Defined in: [lib/core.ts:
|
|
4871
|
+
Defined in: [lib/core.ts:106](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L106)
|
|
4570
4872
|
|
|
4571
4873
|
大写字母字符集
|
|
4572
4874
|
|
|
@@ -4583,7 +4885,7 @@ lib/core/variables/RANDOM_UN.md
|
|
|
4583
4885
|
|
|
4584
4886
|
> `const` **RANDOM\_UN**: `string`
|
|
4585
4887
|
|
|
4586
|
-
Defined in: [lib/core.ts:
|
|
4888
|
+
Defined in: [lib/core.ts:111](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L111)
|
|
4587
4889
|
|
|
4588
4890
|
大写字母 + 数字字符集
|
|
4589
4891
|
|
|
@@ -4600,7 +4902,7 @@ lib/core/variables/RANDOM_V.md
|
|
|
4600
4902
|
|
|
4601
4903
|
> `const` **RANDOM\_V**: `"ACEFGHJKLMNPRSTWXY34567"` = `'ACEFGHJKLMNPRSTWXY34567'`
|
|
4602
4904
|
|
|
4603
|
-
Defined in: [lib/core.ts:
|
|
4905
|
+
Defined in: [lib/core.ts:119](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L119)
|
|
4604
4906
|
|
|
4605
4907
|
验证码字符集
|
|
4606
4908
|
|
|
@@ -4617,7 +4919,7 @@ lib/core/variables/REAL_IP_CF.md
|
|
|
4617
4919
|
|
|
4618
4920
|
> `const` **REAL\_IP\_CF**: `"cf-connecting-ip"` = `'cf-connecting-ip'`
|
|
4619
4921
|
|
|
4620
|
-
Defined in: [lib/core.ts:
|
|
4922
|
+
Defined in: [lib/core.ts:385](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L385)
|
|
4621
4923
|
|
|
4622
4924
|
使用的是 Cloudflare
|
|
4623
4925
|
|
|
@@ -4634,7 +4936,7 @@ lib/core/variables/REAL_IP_X.md
|
|
|
4634
4936
|
|
|
4635
4937
|
> `const` **REAL\_IP\_X**: `"x-forwarded-for"` = `'x-forwarded-for'`
|
|
4636
4938
|
|
|
4637
|
-
Defined in: [lib/core.ts:
|
|
4939
|
+
Defined in: [lib/core.ts:383](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L383)
|
|
4638
4940
|
|
|
4639
4941
|
使用 X-Forwarded-For 的 CDN 厂商
|
|
4640
4942
|
|
|
@@ -7417,7 +7719,7 @@ Defined in: [lib/dns.ts:106](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
7417
7719
|
|
|
7418
7720
|
> **addDomainRecord**(`opt`): `Promise`\<[`IAddDomainRecord`](../interfaces/IAddDomainRecord.md) \| `null`\>
|
|
7419
7721
|
|
|
7420
|
-
Defined in: [lib/dns.ts:
|
|
7722
|
+
Defined in: [lib/dns.ts:223](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L223)
|
|
7421
7723
|
|
|
7422
7724
|
添加记录
|
|
7423
7725
|
|
|
@@ -7465,7 +7767,7 @@ Defined in: [lib/dns.ts:224](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
7465
7767
|
|
|
7466
7768
|
> **deleteDomainRecord**(`opt`): `Promise`\<\{ `success`: `boolean`; \} \| `null`\>
|
|
7467
7769
|
|
|
7468
|
-
Defined in: [lib/dns.ts:
|
|
7770
|
+
Defined in: [lib/dns.ts:358](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L358)
|
|
7469
7771
|
|
|
7470
7772
|
删除记录
|
|
7471
7773
|
|
|
@@ -7493,7 +7795,7 @@ Defined in: [lib/dns.ts:359](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
7493
7795
|
|
|
7494
7796
|
> **getDomainList**(`opt`): `Promise`\<[`IDomainList`](../interfaces/IDomainList.md) \| `null`\>
|
|
7495
7797
|
|
|
7496
|
-
Defined in: [lib/dns.ts:
|
|
7798
|
+
Defined in: [lib/dns.ts:157](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L157)
|
|
7497
7799
|
|
|
7498
7800
|
获取域名列表
|
|
7499
7801
|
|
|
@@ -7521,7 +7823,7 @@ Defined in: [lib/dns.ts:158](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
7521
7823
|
|
|
7522
7824
|
> **updateDomainRecord**(`opt`): `Promise`\<[`IAddDomainRecord`](../interfaces/IAddDomainRecord.md) \| `null`\>
|
|
7523
7825
|
|
|
7524
|
-
Defined in: [lib/dns.ts:
|
|
7826
|
+
Defined in: [lib/dns.ts:289](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L289)
|
|
7525
7827
|
|
|
7526
7828
|
修改记录
|
|
7527
7829
|
|
|
@@ -7745,7 +8047,7 @@ lib/dns/functions/get.md
|
|
|
7745
8047
|
|
|
7746
8048
|
> **get**(`ctr`, `opt`): [`Dns`](../classes/Dns.md)
|
|
7747
8049
|
|
|
7748
|
-
Defined in: [lib/dns.ts:
|
|
8050
|
+
Defined in: [lib/dns.ts:403](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L403)
|
|
7749
8051
|
|
|
7750
8052
|
创建一个 Dns 对象
|
|
7751
8053
|
|
|
@@ -10502,41 +10804,6 @@ Buffer 数据
|
|
|
10502
10804
|
|
|
10503
10805
|
文件名
|
|
10504
10806
|
|
|
10505
|
-
lib/net/functions/buildCookieQuery.md
|
|
10506
|
-
---
|
|
10507
|
-
|
|
10508
|
-
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
10509
|
-
|
|
10510
|
-
***
|
|
10511
|
-
|
|
10512
|
-
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / buildCookieQuery
|
|
10513
|
-
|
|
10514
|
-
# Function: buildCookieQuery()
|
|
10515
|
-
|
|
10516
|
-
> **buildCookieQuery**(`cookie`, `uri`): `string`
|
|
10517
|
-
|
|
10518
|
-
Defined in: [lib/net.ts:661](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L661)
|
|
10519
|
-
|
|
10520
|
-
对象转换为 Cookie 拼接字符串(会自动筛掉不能发送的 cookie)
|
|
10521
|
-
|
|
10522
|
-
## Parameters
|
|
10523
|
-
|
|
10524
|
-
### cookie
|
|
10525
|
-
|
|
10526
|
-
`Record`\<`string`, [`ICookie`](../interfaces/ICookie.md)\>
|
|
10527
|
-
|
|
10528
|
-
cookie 对象
|
|
10529
|
-
|
|
10530
|
-
### uri
|
|
10531
|
-
|
|
10532
|
-
[`IUrlParse`](../../../index/interfaces/IUrlParse.md)
|
|
10533
|
-
|
|
10534
|
-
请求的 URI 对象
|
|
10535
|
-
|
|
10536
|
-
## Returns
|
|
10537
|
-
|
|
10538
|
-
`string`
|
|
10539
|
-
|
|
10540
10807
|
lib/net/functions/fetch.md
|
|
10541
10808
|
---
|
|
10542
10809
|
|
|
@@ -10585,7 +10852,7 @@ lib/net/functions/filterHeaders.md
|
|
|
10585
10852
|
|
|
10586
10853
|
> **filterHeaders**(`headers`, `res?`, `filter?`): `Record`\<`string`, `string` \| `string`[]\>
|
|
10587
10854
|
|
|
10588
|
-
Defined in: [lib/net.ts:
|
|
10855
|
+
Defined in: [lib/net.ts:510](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L510)
|
|
10589
10856
|
|
|
10590
10857
|
剔除不代理的 header,返回新的 header
|
|
10591
10858
|
|
|
@@ -10647,7 +10914,7 @@ lib/net/functions/getFormData.md
|
|
|
10647
10914
|
|
|
10648
10915
|
> **getFormData**(): [`FormData`](../formdata/classes/FormData.md)
|
|
10649
10916
|
|
|
10650
|
-
Defined in: [lib/net.ts:
|
|
10917
|
+
Defined in: [lib/net.ts:494](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L494)
|
|
10651
10918
|
|
|
10652
10919
|
创建 FormData 对象
|
|
10653
10920
|
|
|
@@ -10740,7 +11007,7 @@ lib/net/functions/mproxyData.md
|
|
|
10740
11007
|
|
|
10741
11008
|
> **mproxyData**(`ctr`): `any`
|
|
10742
11009
|
|
|
10743
|
-
Defined in: [lib/net.ts:
|
|
11010
|
+
Defined in: [lib/net.ts:598](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L598)
|
|
10744
11011
|
|
|
10745
11012
|
获取 mproxy 的附加数据
|
|
10746
11013
|
|
|
@@ -10769,7 +11036,7 @@ lib/net/functions/mproxy.md
|
|
|
10769
11036
|
|
|
10770
11037
|
> **mproxy**(`ctr`, `auth`, `opt?`): `Promise`\<`number`\>
|
|
10771
11038
|
|
|
10772
|
-
Defined in: [lib/net.ts:
|
|
11039
|
+
Defined in: [lib/net.ts:546](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L546)
|
|
10773
11040
|
|
|
10774
11041
|
正向 mproxy 代理,注意提前处理不要自动处理 post 数据,读取 get 的 url 为实际请求地址
|
|
10775
11042
|
get: url, auth
|
|
@@ -10987,35 +11254,6 @@ Defined in: [lib/net.ts:305](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
10987
11254
|
|
|
10988
11255
|
`Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
10989
11256
|
|
|
10990
|
-
lib/net/functions/resetCookieSession.md
|
|
10991
|
-
---
|
|
10992
|
-
|
|
10993
|
-
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
10994
|
-
|
|
10995
|
-
***
|
|
10996
|
-
|
|
10997
|
-
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / resetCookieSession
|
|
10998
|
-
|
|
10999
|
-
# Function: resetCookieSession()
|
|
11000
|
-
|
|
11001
|
-
> **resetCookieSession**(`cookie`): `void`
|
|
11002
|
-
|
|
11003
|
-
Defined in: [lib/net.ts:711](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L711)
|
|
11004
|
-
|
|
11005
|
-
模拟重启浏览器后的状态
|
|
11006
|
-
|
|
11007
|
-
## Parameters
|
|
11008
|
-
|
|
11009
|
-
### cookie
|
|
11010
|
-
|
|
11011
|
-
`Record`\<`string`, [`ICookie`](../interfaces/ICookie.md)\>
|
|
11012
|
-
|
|
11013
|
-
cookie 对象
|
|
11014
|
-
|
|
11015
|
-
## Returns
|
|
11016
|
-
|
|
11017
|
-
`void`
|
|
11018
|
-
|
|
11019
11257
|
lib/net/functions/rproxy.md
|
|
11020
11258
|
---
|
|
11021
11259
|
|
|
@@ -11029,7 +11267,7 @@ lib/net/functions/rproxy.md
|
|
|
11029
11267
|
|
|
11030
11268
|
> **rproxy**(`ctr`, `route`, `opt?`): `Promise`\<`boolean`\>
|
|
11031
11269
|
|
|
11032
|
-
Defined in: [lib/net.ts:
|
|
11270
|
+
Defined in: [lib/net.ts:616](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L616)
|
|
11033
11271
|
|
|
11034
11272
|
反向代理,注意提前处理不要自动处理 post 数据,将本服务器的某个路由反代到其他网址
|
|
11035
11273
|
|
|
@@ -11057,73 +11295,6 @@ Defined in: [lib/net.ts:845](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11057
11295
|
|
|
11058
11296
|
`Promise`\<`boolean`\>
|
|
11059
11297
|
|
|
11060
|
-
lib/net/functions/setCookie.md
|
|
11061
|
-
---
|
|
11062
|
-
|
|
11063
|
-
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
11064
|
-
|
|
11065
|
-
***
|
|
11066
|
-
|
|
11067
|
-
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / setCookie
|
|
11068
|
-
|
|
11069
|
-
# Function: setCookie()
|
|
11070
|
-
|
|
11071
|
-
> **setCookie**(`cookie`, `name`, `value`, `domain`, `opt?`): `void`
|
|
11072
|
-
|
|
11073
|
-
Defined in: [lib/net.ts:499](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L499)
|
|
11074
|
-
|
|
11075
|
-
对 cookie 对象进行操作
|
|
11076
|
-
|
|
11077
|
-
## Parameters
|
|
11078
|
-
|
|
11079
|
-
### cookie
|
|
11080
|
-
|
|
11081
|
-
`Record`\<`string`, [`ICookie`](../interfaces/ICookie.md)\>
|
|
11082
|
-
|
|
11083
|
-
要操作的对象
|
|
11084
|
-
|
|
11085
|
-
### name
|
|
11086
|
-
|
|
11087
|
-
`string`
|
|
11088
|
-
|
|
11089
|
-
名
|
|
11090
|
-
|
|
11091
|
-
### value
|
|
11092
|
-
|
|
11093
|
-
`string`
|
|
11094
|
-
|
|
11095
|
-
值
|
|
11096
|
-
|
|
11097
|
-
### domain
|
|
11098
|
-
|
|
11099
|
-
`string`
|
|
11100
|
-
|
|
11101
|
-
应用网址,如 .xxx.com
|
|
11102
|
-
|
|
11103
|
-
### opt?
|
|
11104
|
-
|
|
11105
|
-
选项 ttl, path, ssl, httponly
|
|
11106
|
-
|
|
11107
|
-
#### httponly?
|
|
11108
|
-
|
|
11109
|
-
`boolean`
|
|
11110
|
-
|
|
11111
|
-
#### path?
|
|
11112
|
-
|
|
11113
|
-
`string`
|
|
11114
|
-
|
|
11115
|
-
#### ssl?
|
|
11116
|
-
|
|
11117
|
-
`boolean`
|
|
11118
|
-
|
|
11119
|
-
#### ttl?
|
|
11120
|
-
|
|
11121
|
-
`number`
|
|
11122
|
-
|
|
11123
|
-
## Returns
|
|
11124
|
-
|
|
11125
|
-
`void`
|
|
11126
|
-
|
|
11127
11298
|
lib/net/index.md
|
|
11128
11299
|
---
|
|
11129
11300
|
|
|
@@ -11137,7 +11308,6 @@ lib/net/index.md
|
|
|
11137
11308
|
|
|
11138
11309
|
## Interfaces
|
|
11139
11310
|
|
|
11140
|
-
- [ICookie](interfaces/ICookie.md)
|
|
11141
11311
|
- [IMproxyOptions](interfaces/IMproxyOptions.md)
|
|
11142
11312
|
- [IRequestOptions](interfaces/IRequestOptions.md)
|
|
11143
11313
|
- [IRproxyOptions](interfaces/IRproxyOptions.md)
|
|
@@ -11148,7 +11318,6 @@ lib/net/index.md
|
|
|
11148
11318
|
|
|
11149
11319
|
## Functions
|
|
11150
11320
|
|
|
11151
|
-
- [buildCookieQuery](functions/buildCookieQuery.md)
|
|
11152
11321
|
- [fetch](functions/fetch.md)
|
|
11153
11322
|
- [filterHeaders](functions/filterHeaders.md)
|
|
11154
11323
|
- [get](functions/get.md)
|
|
@@ -11162,82 +11331,7 @@ lib/net/index.md
|
|
|
11162
11331
|
- [postJson](functions/postJson.md)
|
|
11163
11332
|
- [postJsonResponseJson](functions/postJsonResponseJson.md)
|
|
11164
11333
|
- [request](functions/request.md)
|
|
11165
|
-
- [resetCookieSession](functions/resetCookieSession.md)
|
|
11166
11334
|
- [rproxy](functions/rproxy.md)
|
|
11167
|
-
- [setCookie](functions/setCookie.md)
|
|
11168
|
-
|
|
11169
|
-
lib/net/interfaces/ICookie.md
|
|
11170
|
-
---
|
|
11171
|
-
|
|
11172
|
-
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
11173
|
-
|
|
11174
|
-
***
|
|
11175
|
-
|
|
11176
|
-
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / ICookie
|
|
11177
|
-
|
|
11178
|
-
# Interface: ICookie
|
|
11179
|
-
|
|
11180
|
-
Defined in: [lib/net.ts:976](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L976)
|
|
11181
|
-
|
|
11182
|
-
Net Cookie 对象
|
|
11183
|
-
|
|
11184
|
-
## Properties
|
|
11185
|
-
|
|
11186
|
-
### domain
|
|
11187
|
-
|
|
11188
|
-
> **domain**: `string`
|
|
11189
|
-
|
|
11190
|
-
Defined in: [lib/net.ts:982](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L982)
|
|
11191
|
-
|
|
11192
|
-
***
|
|
11193
|
-
|
|
11194
|
-
### exp
|
|
11195
|
-
|
|
11196
|
-
> **exp**: `number`
|
|
11197
|
-
|
|
11198
|
-
Defined in: [lib/net.ts:980](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L980)
|
|
11199
|
-
|
|
11200
|
-
有效期秒级时间戳
|
|
11201
|
-
|
|
11202
|
-
***
|
|
11203
|
-
|
|
11204
|
-
### httponly
|
|
11205
|
-
|
|
11206
|
-
> **httponly**: `boolean`
|
|
11207
|
-
|
|
11208
|
-
Defined in: [lib/net.ts:984](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L984)
|
|
11209
|
-
|
|
11210
|
-
***
|
|
11211
|
-
|
|
11212
|
-
### name
|
|
11213
|
-
|
|
11214
|
-
> **name**: `string`
|
|
11215
|
-
|
|
11216
|
-
Defined in: [lib/net.ts:977](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L977)
|
|
11217
|
-
|
|
11218
|
-
***
|
|
11219
|
-
|
|
11220
|
-
### path
|
|
11221
|
-
|
|
11222
|
-
> **path**: `string`
|
|
11223
|
-
|
|
11224
|
-
Defined in: [lib/net.ts:981](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L981)
|
|
11225
|
-
|
|
11226
|
-
***
|
|
11227
|
-
|
|
11228
|
-
### secure
|
|
11229
|
-
|
|
11230
|
-
> **secure**: `boolean`
|
|
11231
|
-
|
|
11232
|
-
Defined in: [lib/net.ts:983](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L983)
|
|
11233
|
-
|
|
11234
|
-
***
|
|
11235
|
-
|
|
11236
|
-
### value
|
|
11237
|
-
|
|
11238
|
-
> **value**: `string`
|
|
11239
|
-
|
|
11240
|
-
Defined in: [lib/net.ts:978](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L978)
|
|
11241
11335
|
|
|
11242
11336
|
lib/net/interfaces/IMproxyOptions.md
|
|
11243
11337
|
---
|
|
@@ -11250,7 +11344,7 @@ lib/net/interfaces/IMproxyOptions.md
|
|
|
11250
11344
|
|
|
11251
11345
|
# Interface: IMproxyOptions
|
|
11252
11346
|
|
|
11253
|
-
Defined in: [lib/net.ts:
|
|
11347
|
+
Defined in: [lib/net.ts:700](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L700)
|
|
11254
11348
|
|
|
11255
11349
|
正向代理请求的传入参数选项
|
|
11256
11350
|
|
|
@@ -11260,7 +11354,7 @@ Defined in: [lib/net.ts:929](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11260
11354
|
|
|
11261
11355
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
11262
11356
|
|
|
11263
|
-
Defined in: [lib/net.ts:
|
|
11357
|
+
Defined in: [lib/net.ts:709](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L709)
|
|
11264
11358
|
|
|
11265
11359
|
过滤 header,返回 true 则留下
|
|
11266
11360
|
|
|
@@ -11280,7 +11374,7 @@ Defined in: [lib/net.ts:938](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11280
11374
|
|
|
11281
11375
|
> `optional` **follow?**: `number`
|
|
11282
11376
|
|
|
11283
|
-
Defined in: [lib/net.ts:
|
|
11377
|
+
Defined in: [lib/net.ts:703](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L703)
|
|
11284
11378
|
|
|
11285
11379
|
***
|
|
11286
11380
|
|
|
@@ -11288,7 +11382,7 @@ Defined in: [lib/net.ts:932](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11288
11382
|
|
|
11289
11383
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11290
11384
|
|
|
11291
|
-
Defined in: [lib/net.ts:
|
|
11385
|
+
Defined in: [lib/net.ts:707](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L707)
|
|
11292
11386
|
|
|
11293
11387
|
***
|
|
11294
11388
|
|
|
@@ -11296,7 +11390,7 @@ Defined in: [lib/net.ts:936](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11296
11390
|
|
|
11297
11391
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11298
11392
|
|
|
11299
|
-
Defined in: [lib/net.ts:
|
|
11393
|
+
Defined in: [lib/net.ts:705](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L705)
|
|
11300
11394
|
|
|
11301
11395
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
11302
11396
|
|
|
@@ -11306,7 +11400,7 @@ Defined in: [lib/net.ts:934](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11306
11400
|
|
|
11307
11401
|
> `optional` **local?**: `string`
|
|
11308
11402
|
|
|
11309
|
-
Defined in: [lib/net.ts:
|
|
11403
|
+
Defined in: [lib/net.ts:706](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L706)
|
|
11310
11404
|
|
|
11311
11405
|
***
|
|
11312
11406
|
|
|
@@ -11314,7 +11408,7 @@ Defined in: [lib/net.ts:935](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11314
11408
|
|
|
11315
11409
|
> `optional` **reuse?**: `string`
|
|
11316
11410
|
|
|
11317
|
-
Defined in: [lib/net.ts:
|
|
11411
|
+
Defined in: [lib/net.ts:711](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L711)
|
|
11318
11412
|
|
|
11319
11413
|
默认为 default
|
|
11320
11414
|
|
|
@@ -11324,7 +11418,7 @@ Defined in: [lib/net.ts:940](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11324
11418
|
|
|
11325
11419
|
> `optional` **timeout?**: `number`
|
|
11326
11420
|
|
|
11327
|
-
Defined in: [lib/net.ts:
|
|
11421
|
+
Defined in: [lib/net.ts:702](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L702)
|
|
11328
11422
|
|
|
11329
11423
|
秒数
|
|
11330
11424
|
|
|
@@ -11339,7 +11433,7 @@ lib/net/interfaces/IRequestOptions.md
|
|
|
11339
11433
|
|
|
11340
11434
|
# Interface: IRequestOptions
|
|
11341
11435
|
|
|
11342
|
-
Defined in: [lib/net.ts:
|
|
11436
|
+
Defined in: [lib/net.ts:669](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L669)
|
|
11343
11437
|
|
|
11344
11438
|
请求的传入参数选项
|
|
11345
11439
|
|
|
@@ -11347,9 +11441,9 @@ Defined in: [lib/net.ts:898](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11347
11441
|
|
|
11348
11442
|
### cookie?
|
|
11349
11443
|
|
|
11350
|
-
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](ICookie.md)\>
|
|
11444
|
+
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../cookie/interfaces/ICookie.md)\>
|
|
11351
11445
|
|
|
11352
|
-
Defined in: [lib/net.ts:
|
|
11446
|
+
Defined in: [lib/net.ts:694](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L694)
|
|
11353
11447
|
|
|
11354
11448
|
cookie 托管对象
|
|
11355
11449
|
|
|
@@ -11359,7 +11453,7 @@ cookie 托管对象
|
|
|
11359
11453
|
|
|
11360
11454
|
> `optional` **follow?**: `number`
|
|
11361
11455
|
|
|
11362
|
-
Defined in: [lib/net.ts:
|
|
11456
|
+
Defined in: [lib/net.ts:675](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L675)
|
|
11363
11457
|
|
|
11364
11458
|
追踪 location 次数,0 为不追踪,默认为 0
|
|
11365
11459
|
|
|
@@ -11369,7 +11463,7 @@ Defined in: [lib/net.ts:904](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11369
11463
|
|
|
11370
11464
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11371
11465
|
|
|
11372
|
-
Defined in: [lib/net.ts:
|
|
11466
|
+
Defined in: [lib/net.ts:680](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L680)
|
|
11373
11467
|
|
|
11374
11468
|
***
|
|
11375
11469
|
|
|
@@ -11377,7 +11471,7 @@ Defined in: [lib/net.ts:909](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11377
11471
|
|
|
11378
11472
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11379
11473
|
|
|
11380
|
-
Defined in: [lib/net.ts:
|
|
11474
|
+
Defined in: [lib/net.ts:677](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L677)
|
|
11381
11475
|
|
|
11382
11476
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
11383
11477
|
|
|
@@ -11387,7 +11481,7 @@ Defined in: [lib/net.ts:906](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11387
11481
|
|
|
11388
11482
|
> `optional` **keep?**: `boolean`
|
|
11389
11483
|
|
|
11390
|
-
Defined in: [lib/net.ts:
|
|
11484
|
+
Defined in: [lib/net.ts:690](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L690)
|
|
11391
11485
|
|
|
11392
11486
|
连接是否保持长连接(即是否允许复用),默认为 true
|
|
11393
11487
|
|
|
@@ -11397,7 +11491,7 @@ Defined in: [lib/net.ts:919](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11397
11491
|
|
|
11398
11492
|
> `optional` **local?**: `string`
|
|
11399
11493
|
|
|
11400
|
-
Defined in: [lib/net.ts:
|
|
11494
|
+
Defined in: [lib/net.ts:679](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L679)
|
|
11401
11495
|
|
|
11402
11496
|
***
|
|
11403
11497
|
|
|
@@ -11405,7 +11499,7 @@ Defined in: [lib/net.ts:908](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11405
11499
|
|
|
11406
11500
|
> `optional` **log?**: `boolean`
|
|
11407
11501
|
|
|
11408
|
-
Defined in: [lib/net.ts:
|
|
11502
|
+
Defined in: [lib/net.ts:696](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L696)
|
|
11409
11503
|
|
|
11410
11504
|
若有异常写入文件日志,默认为 true
|
|
11411
11505
|
|
|
@@ -11415,7 +11509,7 @@ Defined in: [lib/net.ts:925](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11415
11509
|
|
|
11416
11510
|
> `optional` **method?**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"OPTIONS"`
|
|
11417
11511
|
|
|
11418
|
-
Defined in: [lib/net.ts:
|
|
11512
|
+
Defined in: [lib/net.ts:670](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L670)
|
|
11419
11513
|
|
|
11420
11514
|
***
|
|
11421
11515
|
|
|
@@ -11423,7 +11517,7 @@ Defined in: [lib/net.ts:899](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11423
11517
|
|
|
11424
11518
|
> `optional` **mproxy?**: `object`
|
|
11425
11519
|
|
|
11426
|
-
Defined in: [lib/net.ts:
|
|
11520
|
+
Defined in: [lib/net.ts:682](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L682)
|
|
11427
11521
|
|
|
11428
11522
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
11429
11523
|
|
|
@@ -11451,7 +11545,7 @@ Defined in: [lib/net.ts:911](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11451
11545
|
|
|
11452
11546
|
> `optional` **reuse?**: `string`
|
|
11453
11547
|
|
|
11454
|
-
Defined in: [lib/net.ts:
|
|
11548
|
+
Defined in: [lib/net.ts:692](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L692)
|
|
11455
11549
|
|
|
11456
11550
|
复用池名,默认为 default
|
|
11457
11551
|
|
|
@@ -11461,7 +11555,7 @@ Defined in: [lib/net.ts:921](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11461
11555
|
|
|
11462
11556
|
> `optional` **save?**: `string`
|
|
11463
11557
|
|
|
11464
|
-
Defined in: [lib/net.ts:
|
|
11558
|
+
Defined in: [lib/net.ts:678](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L678)
|
|
11465
11559
|
|
|
11466
11560
|
***
|
|
11467
11561
|
|
|
@@ -11469,9 +11563,9 @@ Defined in: [lib/net.ts:907](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11469
11563
|
|
|
11470
11564
|
> `optional` **timeout?**: `number`
|
|
11471
11565
|
|
|
11472
|
-
Defined in: [lib/net.ts:
|
|
11566
|
+
Defined in: [lib/net.ts:673](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L673)
|
|
11473
11567
|
|
|
11474
|
-
|
|
11568
|
+
秒数,默认 10 秒
|
|
11475
11569
|
|
|
11476
11570
|
***
|
|
11477
11571
|
|
|
@@ -11479,7 +11573,7 @@ Defined in: [lib/net.ts:902](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11479
11573
|
|
|
11480
11574
|
> `optional` **type?**: `"form"` \| `"json"`
|
|
11481
11575
|
|
|
11482
|
-
Defined in: [lib/net.ts:
|
|
11576
|
+
Defined in: [lib/net.ts:671](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L671)
|
|
11483
11577
|
|
|
11484
11578
|
lib/net/interfaces/IRproxyOptions.md
|
|
11485
11579
|
---
|
|
@@ -11492,7 +11586,7 @@ lib/net/interfaces/IRproxyOptions.md
|
|
|
11492
11586
|
|
|
11493
11587
|
# Interface: IRproxyOptions
|
|
11494
11588
|
|
|
11495
|
-
Defined in: [lib/net.ts:
|
|
11589
|
+
Defined in: [lib/net.ts:715](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L715)
|
|
11496
11590
|
|
|
11497
11591
|
反向代理请求的传入参数选项
|
|
11498
11592
|
|
|
@@ -11502,7 +11596,7 @@ Defined in: [lib/net.ts:944](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11502
11596
|
|
|
11503
11597
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
11504
11598
|
|
|
11505
|
-
Defined in: [lib/net.ts:
|
|
11599
|
+
Defined in: [lib/net.ts:724](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L724)
|
|
11506
11600
|
|
|
11507
11601
|
过滤 header,返回 true 则留下
|
|
11508
11602
|
|
|
@@ -11522,7 +11616,7 @@ Defined in: [lib/net.ts:953](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11522
11616
|
|
|
11523
11617
|
> `optional` **follow?**: `number`
|
|
11524
11618
|
|
|
11525
|
-
Defined in: [lib/net.ts:
|
|
11619
|
+
Defined in: [lib/net.ts:718](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L718)
|
|
11526
11620
|
|
|
11527
11621
|
***
|
|
11528
11622
|
|
|
@@ -11530,7 +11624,7 @@ Defined in: [lib/net.ts:947](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11530
11624
|
|
|
11531
11625
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11532
11626
|
|
|
11533
|
-
Defined in: [lib/net.ts:
|
|
11627
|
+
Defined in: [lib/net.ts:722](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L722)
|
|
11534
11628
|
|
|
11535
11629
|
***
|
|
11536
11630
|
|
|
@@ -11538,7 +11632,7 @@ Defined in: [lib/net.ts:951](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11538
11632
|
|
|
11539
11633
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11540
11634
|
|
|
11541
|
-
Defined in: [lib/net.ts:
|
|
11635
|
+
Defined in: [lib/net.ts:720](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L720)
|
|
11542
11636
|
|
|
11543
11637
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
11544
11638
|
|
|
@@ -11548,7 +11642,7 @@ Defined in: [lib/net.ts:949](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11548
11642
|
|
|
11549
11643
|
> `optional` **local?**: `string`
|
|
11550
11644
|
|
|
11551
|
-
Defined in: [lib/net.ts:
|
|
11645
|
+
Defined in: [lib/net.ts:721](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L721)
|
|
11552
11646
|
|
|
11553
11647
|
***
|
|
11554
11648
|
|
|
@@ -11556,7 +11650,7 @@ Defined in: [lib/net.ts:950](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11556
11650
|
|
|
11557
11651
|
> `optional` **mproxy?**: `object`
|
|
11558
11652
|
|
|
11559
|
-
Defined in: [lib/net.ts:
|
|
11653
|
+
Defined in: [lib/net.ts:726](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L726)
|
|
11560
11654
|
|
|
11561
11655
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
11562
11656
|
|
|
@@ -11584,7 +11678,7 @@ Defined in: [lib/net.ts:955](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11584
11678
|
|
|
11585
11679
|
> `optional` **reuse?**: `string`
|
|
11586
11680
|
|
|
11587
|
-
Defined in: [lib/net.ts:
|
|
11681
|
+
Defined in: [lib/net.ts:734](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L734)
|
|
11588
11682
|
|
|
11589
11683
|
默认为 default
|
|
11590
11684
|
|
|
@@ -11594,7 +11688,7 @@ Defined in: [lib/net.ts:963](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11594
11688
|
|
|
11595
11689
|
> `optional` **timeout?**: `number`
|
|
11596
11690
|
|
|
11597
|
-
Defined in: [lib/net.ts:
|
|
11691
|
+
Defined in: [lib/net.ts:717](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L717)
|
|
11598
11692
|
|
|
11599
11693
|
秒数
|
|
11600
11694
|
|
|
@@ -11609,7 +11703,7 @@ lib/net/request/classes/Request.md
|
|
|
11609
11703
|
|
|
11610
11704
|
# Class: Request
|
|
11611
11705
|
|
|
11612
|
-
Defined in: [lib/net/request.ts:
|
|
11706
|
+
Defined in: [lib/net/request.ts:11](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L11)
|
|
11613
11707
|
|
|
11614
11708
|
## Constructors
|
|
11615
11709
|
|
|
@@ -11617,7 +11711,7 @@ Defined in: [lib/net/request.ts:10](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11617
11711
|
|
|
11618
11712
|
> **new Request**(`url`): `Request`
|
|
11619
11713
|
|
|
11620
|
-
Defined in: [lib/net/request.ts:
|
|
11714
|
+
Defined in: [lib/net/request.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L22)
|
|
11621
11715
|
|
|
11622
11716
|
#### Parameters
|
|
11623
11717
|
|
|
@@ -11635,7 +11729,7 @@ Defined in: [lib/net/request.ts:21](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11635
11729
|
|
|
11636
11730
|
> **data**(`data`): `this`
|
|
11637
11731
|
|
|
11638
|
-
Defined in: [lib/net/request.ts:
|
|
11732
|
+
Defined in: [lib/net/request.ts:30](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L30)
|
|
11639
11733
|
|
|
11640
11734
|
设置 get 或 post 的数据
|
|
11641
11735
|
|
|
@@ -11657,7 +11751,7 @@ Defined in: [lib/net/request.ts:29](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11657
11751
|
|
|
11658
11752
|
> **follow**(`follow?`): `this`
|
|
11659
11753
|
|
|
11660
|
-
Defined in: [lib/net/request.ts:
|
|
11754
|
+
Defined in: [lib/net/request.ts:87](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L87)
|
|
11661
11755
|
|
|
11662
11756
|
设置是否跟随请求方的 location,留空为跟随,不设置为不跟随
|
|
11663
11757
|
|
|
@@ -11677,7 +11771,7 @@ Defined in: [lib/net/request.ts:86](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11677
11771
|
|
|
11678
11772
|
> **get**(): `this`
|
|
11679
11773
|
|
|
11680
|
-
Defined in: [lib/net/request.ts:
|
|
11774
|
+
Defined in: [lib/net/request.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L47)
|
|
11681
11775
|
|
|
11682
11776
|
method get 方法别名
|
|
11683
11777
|
|
|
@@ -11691,7 +11785,7 @@ method get 方法别名
|
|
|
11691
11785
|
|
|
11692
11786
|
> **headers**(`headers`): `this`
|
|
11693
11787
|
|
|
11694
|
-
Defined in: [lib/net/request.ts:
|
|
11788
|
+
Defined in: [lib/net/request.ts:123](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L123)
|
|
11695
11789
|
|
|
11696
11790
|
批量设置提交的 headers
|
|
11697
11791
|
|
|
@@ -11711,7 +11805,7 @@ Defined in: [lib/net/request.ts:122](https://github.com/maiyunnet/kebab/blob/mas
|
|
|
11711
11805
|
|
|
11712
11806
|
> **hosts**(`hosts`): `this`
|
|
11713
11807
|
|
|
11714
|
-
Defined in: [lib/net/request.ts:
|
|
11808
|
+
Defined in: [lib/net/request.ts:96](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L96)
|
|
11715
11809
|
|
|
11716
11810
|
设置域名 -> ip的对应键值,就像电脑里的 hosts 一样
|
|
11717
11811
|
|
|
@@ -11731,7 +11825,7 @@ Defined in: [lib/net/request.ts:95](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11731
11825
|
|
|
11732
11826
|
> **json**(): `this`
|
|
11733
11827
|
|
|
11734
|
-
Defined in: [lib/net/request.ts:
|
|
11828
|
+
Defined in: [lib/net/request.ts:70](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L70)
|
|
11735
11829
|
|
|
11736
11830
|
type json 方法别名
|
|
11737
11831
|
|
|
@@ -11745,7 +11839,7 @@ type json 方法别名
|
|
|
11745
11839
|
|
|
11746
11840
|
> **local**(`addr`): `this`
|
|
11747
11841
|
|
|
11748
|
-
Defined in: [lib/net/request.ts:
|
|
11842
|
+
Defined in: [lib/net/request.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L114)
|
|
11749
11843
|
|
|
11750
11844
|
设置使用的本地网卡 IP
|
|
11751
11845
|
|
|
@@ -11765,7 +11859,7 @@ Defined in: [lib/net/request.ts:113](https://github.com/maiyunnet/kebab/blob/mas
|
|
|
11765
11859
|
|
|
11766
11860
|
> **method**(`method`): `this`
|
|
11767
11861
|
|
|
11768
|
-
Defined in: [lib/net/request.ts:
|
|
11862
|
+
Defined in: [lib/net/request.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L39)
|
|
11769
11863
|
|
|
11770
11864
|
设置 get 或 post 请求
|
|
11771
11865
|
|
|
@@ -11785,7 +11879,7 @@ Defined in: [lib/net/request.ts:38](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11785
11879
|
|
|
11786
11880
|
> **post**(): `this`
|
|
11787
11881
|
|
|
11788
|
-
Defined in: [lib/net/request.ts:
|
|
11882
|
+
Defined in: [lib/net/request.ts:54](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L54)
|
|
11789
11883
|
|
|
11790
11884
|
method post 方法别名
|
|
11791
11885
|
|
|
@@ -11799,7 +11893,7 @@ method post 方法别名
|
|
|
11799
11893
|
|
|
11800
11894
|
> **request**(`cookie?`): `Promise`\<[`Response`](../../response/classes/Response.md)\>
|
|
11801
11895
|
|
|
11802
|
-
Defined in: [lib/net/request.ts:
|
|
11896
|
+
Defined in: [lib/net/request.ts:143](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L143)
|
|
11803
11897
|
|
|
11804
11898
|
发起请求
|
|
11805
11899
|
|
|
@@ -11807,7 +11901,7 @@ Defined in: [lib/net/request.ts:142](https://github.com/maiyunnet/kebab/blob/mas
|
|
|
11807
11901
|
|
|
11808
11902
|
##### cookie?
|
|
11809
11903
|
|
|
11810
|
-
`Record`\<`string`, [`ICookie`](
|
|
11904
|
+
`Record`\<`string`, [`ICookie`](../../../cookie/interfaces/ICookie.md)\>
|
|
11811
11905
|
|
|
11812
11906
|
#### Returns
|
|
11813
11907
|
|
|
@@ -11819,7 +11913,7 @@ Defined in: [lib/net/request.ts:142](https://github.com/maiyunnet/kebab/blob/mas
|
|
|
11819
11913
|
|
|
11820
11914
|
> **save**(`save`): `this`
|
|
11821
11915
|
|
|
11822
|
-
Defined in: [lib/net/request.ts:
|
|
11916
|
+
Defined in: [lib/net/request.ts:105](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L105)
|
|
11823
11917
|
|
|
11824
11918
|
设置后将直接保存到本地文件,不会返回,save 为本地实体路径
|
|
11825
11919
|
|
|
@@ -11839,7 +11933,7 @@ Defined in: [lib/net/request.ts:104](https://github.com/maiyunnet/kebab/blob/mas
|
|
|
11839
11933
|
|
|
11840
11934
|
> **setHeader**(`name`, `val`): `this`
|
|
11841
11935
|
|
|
11842
|
-
Defined in: [lib/net/request.ts:
|
|
11936
|
+
Defined in: [lib/net/request.ts:133](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L133)
|
|
11843
11937
|
|
|
11844
11938
|
设置单条 header
|
|
11845
11939
|
|
|
@@ -11863,7 +11957,7 @@ Defined in: [lib/net/request.ts:132](https://github.com/maiyunnet/kebab/blob/mas
|
|
|
11863
11957
|
|
|
11864
11958
|
> **timeout**(`timeout`): `this`
|
|
11865
11959
|
|
|
11866
|
-
Defined in: [lib/net/request.ts:
|
|
11960
|
+
Defined in: [lib/net/request.ts:78](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L78)
|
|
11867
11961
|
|
|
11868
11962
|
设置请求有效期
|
|
11869
11963
|
|
|
@@ -11885,7 +11979,7 @@ Defined in: [lib/net/request.ts:77](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11885
11979
|
|
|
11886
11980
|
> **type**(`type`): `this`
|
|
11887
11981
|
|
|
11888
|
-
Defined in: [lib/net/request.ts:
|
|
11982
|
+
Defined in: [lib/net/request.ts:62](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L62)
|
|
11889
11983
|
|
|
11890
11984
|
设置提交模式,json 还是普通 form
|
|
11891
11985
|
|
|
@@ -12055,7 +12149,7 @@ lib/net/type-aliases/THttpHeaders.md
|
|
|
12055
12149
|
|
|
12056
12150
|
> **THttpHeaders** = `http.IncomingHttpHeaders` & `object`
|
|
12057
12151
|
|
|
12058
|
-
Defined in: [lib/net.ts:
|
|
12152
|
+
Defined in: [lib/net.ts:739](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L739)
|
|
12059
12153
|
|
|
12060
12154
|
http headers
|
|
12061
12155
|
|
|
@@ -13258,7 +13352,7 @@ lib/socket/functions/rwebsocket.md
|
|
|
13258
13352
|
|
|
13259
13353
|
> **rwebsocket**(`port`, `url`, `opt?`): `Server`
|
|
13260
13354
|
|
|
13261
|
-
Defined in: [lib/socket.ts:
|
|
13355
|
+
Defined in: [lib/socket.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L38)
|
|
13262
13356
|
|
|
13263
13357
|
创建一个 Socket 服务器并反代到 WebSocket
|
|
13264
13358
|
|
|
@@ -13316,15 +13410,15 @@ lib/socket/interfaces/IRwebsocketOptions.md
|
|
|
13316
13410
|
|
|
13317
13411
|
# Interface: IRwebsocketOptions
|
|
13318
13412
|
|
|
13319
|
-
Defined in: [lib/socket.ts:
|
|
13413
|
+
Defined in: [lib/socket.ts:13](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L13)
|
|
13320
13414
|
|
|
13321
13415
|
## Properties
|
|
13322
13416
|
|
|
13323
13417
|
### cookie?
|
|
13324
13418
|
|
|
13325
|
-
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../
|
|
13419
|
+
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../cookie/interfaces/ICookie.md)\>
|
|
13326
13420
|
|
|
13327
|
-
Defined in: [lib/socket.ts:
|
|
13421
|
+
Defined in: [lib/socket.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L20)
|
|
13328
13422
|
|
|
13329
13423
|
cookie 托管对象
|
|
13330
13424
|
|
|
@@ -13332,9 +13426,9 @@ cookie 托管对象
|
|
|
13332
13426
|
|
|
13333
13427
|
### headers?
|
|
13334
13428
|
|
|
13335
|
-
> `optional` **headers?**: [`THttpHeaders`](../../
|
|
13429
|
+
> `optional` **headers?**: [`THttpHeaders`](../../undici/type-aliases/THttpHeaders.md)
|
|
13336
13430
|
|
|
13337
|
-
Defined in: [lib/socket.ts:
|
|
13431
|
+
Defined in: [lib/socket.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L18)
|
|
13338
13432
|
|
|
13339
13433
|
***
|
|
13340
13434
|
|
|
@@ -13342,7 +13436,7 @@ Defined in: [lib/socket.ts:17](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13342
13436
|
|
|
13343
13437
|
> `optional` **hosts?**: `Record`\<`string`, `string`\>
|
|
13344
13438
|
|
|
13345
|
-
Defined in: [lib/socket.ts:
|
|
13439
|
+
Defined in: [lib/socket.ts:16](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L16)
|
|
13346
13440
|
|
|
13347
13441
|
***
|
|
13348
13442
|
|
|
@@ -13350,7 +13444,7 @@ Defined in: [lib/socket.ts:15](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13350
13444
|
|
|
13351
13445
|
> `optional` **local?**: `string`
|
|
13352
13446
|
|
|
13353
|
-
Defined in: [lib/socket.ts:
|
|
13447
|
+
Defined in: [lib/socket.ts:17](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L17)
|
|
13354
13448
|
|
|
13355
13449
|
***
|
|
13356
13450
|
|
|
@@ -13358,7 +13452,7 @@ Defined in: [lib/socket.ts:16](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13358
13452
|
|
|
13359
13453
|
> `optional` **masking?**: `boolean`
|
|
13360
13454
|
|
|
13361
|
-
Defined in: [lib/socket.ts:
|
|
13455
|
+
Defined in: [lib/socket.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L24)
|
|
13362
13456
|
|
|
13363
13457
|
加密模式,默认 true
|
|
13364
13458
|
|
|
@@ -13368,7 +13462,7 @@ Defined in: [lib/socket.ts:23](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13368
13462
|
|
|
13369
13463
|
> `optional` **mode?**: [`EFrameReceiveMode`](../../ws/enumerations/EFrameReceiveMode.md)
|
|
13370
13464
|
|
|
13371
|
-
Defined in: [lib/socket.ts:
|
|
13465
|
+
Defined in: [lib/socket.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L22)
|
|
13372
13466
|
|
|
13373
13467
|
小帧模式,默认 false
|
|
13374
13468
|
|
|
@@ -13378,7 +13472,7 @@ Defined in: [lib/socket.ts:21](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13378
13472
|
|
|
13379
13473
|
> `optional` **mproxy?**: `object`
|
|
13380
13474
|
|
|
13381
|
-
Defined in: [lib/socket.ts:
|
|
13475
|
+
Defined in: [lib/socket.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L26)
|
|
13382
13476
|
|
|
13383
13477
|
正向 mproxy 代理,url 如 wss://xxx/abc
|
|
13384
13478
|
|
|
@@ -13396,7 +13490,7 @@ Defined in: [lib/socket.ts:25](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13396
13490
|
|
|
13397
13491
|
> `optional` **timeout?**: `number`
|
|
13398
13492
|
|
|
13399
|
-
Defined in: [lib/socket.ts:
|
|
13493
|
+
Defined in: [lib/socket.ts:15](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L15)
|
|
13400
13494
|
|
|
13401
13495
|
秒数
|
|
13402
13496
|
|
|
@@ -17272,54 +17366,1760 @@ lib/turnstile/index.md
|
|
|
17272
17366
|
|
|
17273
17367
|
- [verify](functions/verify.md)
|
|
17274
17368
|
|
|
17275
|
-
lib/
|
|
17369
|
+
lib/undici/formdata/classes/FormData.md
|
|
17276
17370
|
---
|
|
17277
17371
|
|
|
17278
|
-
[**Documents for @maiyunnet/kebab**](
|
|
17372
|
+
[**Documents for @maiyunnet/kebab**](../../../../index.md)
|
|
17279
17373
|
|
|
17280
17374
|
***
|
|
17281
17375
|
|
|
17282
|
-
[Documents for @maiyunnet/kebab](
|
|
17376
|
+
[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/undici/formdata](../index.md) / FormData
|
|
17283
17377
|
|
|
17284
|
-
# Class:
|
|
17378
|
+
# Class: FormData
|
|
17285
17379
|
|
|
17286
|
-
Defined in: [lib/
|
|
17380
|
+
Defined in: [lib/undici/formdata.ts:37](https://github.com/maiyunnet/kebab/blob/master/lib/undici/formdata.ts#L37)
|
|
17381
|
+
|
|
17382
|
+
## Extends
|
|
17383
|
+
|
|
17384
|
+
- `Readable`
|
|
17287
17385
|
|
|
17288
17386
|
## Constructors
|
|
17289
17387
|
|
|
17290
17388
|
### Constructor
|
|
17291
17389
|
|
|
17292
|
-
> **new
|
|
17390
|
+
> **new FormData**(`options?`): `FormData`
|
|
17293
17391
|
|
|
17294
|
-
Defined in:
|
|
17392
|
+
Defined in: node\_modules/@types/node/stream.d.ts:99
|
|
17295
17393
|
|
|
17296
17394
|
#### Parameters
|
|
17297
17395
|
|
|
17298
|
-
#####
|
|
17396
|
+
##### options?
|
|
17299
17397
|
|
|
17300
|
-
|
|
17398
|
+
`ReadableOptions`\<`Readable`\>
|
|
17301
17399
|
|
|
17302
17400
|
#### Returns
|
|
17303
17401
|
|
|
17304
|
-
`
|
|
17402
|
+
`FormData`
|
|
17305
17403
|
|
|
17306
|
-
|
|
17404
|
+
#### Inherited from
|
|
17307
17405
|
|
|
17308
|
-
|
|
17406
|
+
`stream.Readable.constructor`
|
|
17309
17407
|
|
|
17310
|
-
|
|
17408
|
+
## Methods
|
|
17311
17409
|
|
|
17312
|
-
|
|
17410
|
+
### \_read()
|
|
17313
17411
|
|
|
17314
|
-
|
|
17412
|
+
> **\_read**(): `void`
|
|
17315
17413
|
|
|
17316
|
-
|
|
17414
|
+
Defined in: [lib/undici/formdata.ts:146](https://github.com/maiyunnet/kebab/blob/master/lib/undici/formdata.ts#L146)
|
|
17317
17415
|
|
|
17318
|
-
|
|
17416
|
+
间隔读取(on data 或 pipe 触发)
|
|
17319
17417
|
|
|
17320
|
-
|
|
17418
|
+
#### Returns
|
|
17321
17419
|
|
|
17322
|
-
`
|
|
17420
|
+
`void`
|
|
17421
|
+
|
|
17422
|
+
#### Overrides
|
|
17423
|
+
|
|
17424
|
+
`stream.Readable._read`
|
|
17425
|
+
|
|
17426
|
+
***
|
|
17427
|
+
|
|
17428
|
+
### getBoundary()
|
|
17429
|
+
|
|
17430
|
+
> **getBoundary**(): `string`
|
|
17431
|
+
|
|
17432
|
+
Defined in: [lib/undici/formdata.ts:124](https://github.com/maiyunnet/kebab/blob/master/lib/undici/formdata.ts#L124)
|
|
17433
|
+
|
|
17434
|
+
获取 boundary
|
|
17435
|
+
|
|
17436
|
+
#### Returns
|
|
17437
|
+
|
|
17438
|
+
`string`
|
|
17439
|
+
|
|
17440
|
+
***
|
|
17441
|
+
|
|
17442
|
+
### getLength()
|
|
17443
|
+
|
|
17444
|
+
> **getLength**(): `number`
|
|
17445
|
+
|
|
17446
|
+
Defined in: [lib/undici/formdata.ts:131](https://github.com/maiyunnet/kebab/blob/master/lib/undici/formdata.ts#L131)
|
|
17447
|
+
|
|
17448
|
+
获取总字节长度
|
|
17449
|
+
|
|
17450
|
+
#### Returns
|
|
17451
|
+
|
|
17452
|
+
`number`
|
|
17453
|
+
|
|
17454
|
+
***
|
|
17455
|
+
|
|
17456
|
+
### getSent()
|
|
17457
|
+
|
|
17458
|
+
> **getSent**(): `number`
|
|
17459
|
+
|
|
17460
|
+
Defined in: [lib/undici/formdata.ts:138](https://github.com/maiyunnet/kebab/blob/master/lib/undici/formdata.ts#L138)
|
|
17461
|
+
|
|
17462
|
+
获取已发送的字节长度
|
|
17463
|
+
|
|
17464
|
+
#### Returns
|
|
17465
|
+
|
|
17466
|
+
`number`
|
|
17467
|
+
|
|
17468
|
+
***
|
|
17469
|
+
|
|
17470
|
+
### putBuffer()
|
|
17471
|
+
|
|
17472
|
+
> **putBuffer**(`key`, `buffer`, `fname`): `void`
|
|
17473
|
+
|
|
17474
|
+
Defined in: [lib/undici/formdata.ts:109](https://github.com/maiyunnet/kebab/blob/master/lib/undici/formdata.ts#L109)
|
|
17475
|
+
|
|
17476
|
+
添加 Buffer 数据
|
|
17477
|
+
|
|
17478
|
+
#### Parameters
|
|
17479
|
+
|
|
17480
|
+
##### key
|
|
17481
|
+
|
|
17482
|
+
`string`
|
|
17483
|
+
|
|
17484
|
+
键
|
|
17485
|
+
|
|
17486
|
+
##### buffer
|
|
17487
|
+
|
|
17488
|
+
`Buffer`
|
|
17489
|
+
|
|
17490
|
+
Buffer 数据
|
|
17491
|
+
|
|
17492
|
+
##### fname
|
|
17493
|
+
|
|
17494
|
+
`string`
|
|
17495
|
+
|
|
17496
|
+
文件名
|
|
17497
|
+
|
|
17498
|
+
#### Returns
|
|
17499
|
+
|
|
17500
|
+
`void`
|
|
17501
|
+
|
|
17502
|
+
***
|
|
17503
|
+
|
|
17504
|
+
### putFile()
|
|
17505
|
+
|
|
17506
|
+
> **putFile**(`key`, `path`, `fname?`): `Promise`\<`boolean`\>
|
|
17507
|
+
|
|
17508
|
+
Defined in: [lib/undici/formdata.ts:81](https://github.com/maiyunnet/kebab/blob/master/lib/undici/formdata.ts#L81)
|
|
17509
|
+
|
|
17510
|
+
添加文件
|
|
17511
|
+
|
|
17512
|
+
#### Parameters
|
|
17513
|
+
|
|
17514
|
+
##### key
|
|
17515
|
+
|
|
17516
|
+
`string`
|
|
17517
|
+
|
|
17518
|
+
键
|
|
17519
|
+
|
|
17520
|
+
##### path
|
|
17521
|
+
|
|
17522
|
+
`string`
|
|
17523
|
+
|
|
17524
|
+
路径
|
|
17525
|
+
|
|
17526
|
+
##### fname?
|
|
17527
|
+
|
|
17528
|
+
`string`
|
|
17529
|
+
|
|
17530
|
+
可选,文件名
|
|
17531
|
+
|
|
17532
|
+
#### Returns
|
|
17533
|
+
|
|
17534
|
+
`Promise`\<`boolean`\>
|
|
17535
|
+
|
|
17536
|
+
***
|
|
17537
|
+
|
|
17538
|
+
### putString()
|
|
17539
|
+
|
|
17540
|
+
> **putString**(`key`, `val`): `void`
|
|
17541
|
+
|
|
17542
|
+
Defined in: [lib/undici/formdata.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/undici/formdata.ts#L65)
|
|
17543
|
+
|
|
17544
|
+
添加字符串
|
|
17545
|
+
|
|
17546
|
+
#### Parameters
|
|
17547
|
+
|
|
17548
|
+
##### key
|
|
17549
|
+
|
|
17550
|
+
`string`
|
|
17551
|
+
|
|
17552
|
+
键
|
|
17553
|
+
|
|
17554
|
+
##### val
|
|
17555
|
+
|
|
17556
|
+
`string`
|
|
17557
|
+
|
|
17558
|
+
值
|
|
17559
|
+
|
|
17560
|
+
#### Returns
|
|
17561
|
+
|
|
17562
|
+
`void`
|
|
17563
|
+
|
|
17564
|
+
lib/undici/formdata/index.md
|
|
17565
|
+
---
|
|
17566
|
+
|
|
17567
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17568
|
+
|
|
17569
|
+
***
|
|
17570
|
+
|
|
17571
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / lib/undici/formdata
|
|
17572
|
+
|
|
17573
|
+
# lib/undici/formdata
|
|
17574
|
+
|
|
17575
|
+
## Classes
|
|
17576
|
+
|
|
17577
|
+
- [FormData](classes/FormData.md)
|
|
17578
|
+
|
|
17579
|
+
## Type Aliases
|
|
17580
|
+
|
|
17581
|
+
- [IItem](type-aliases/IItem.md)
|
|
17582
|
+
|
|
17583
|
+
lib/undici/formdata/type-aliases/IItem.md
|
|
17584
|
+
---
|
|
17585
|
+
|
|
17586
|
+
[**Documents for @maiyunnet/kebab**](../../../../index.md)
|
|
17587
|
+
|
|
17588
|
+
***
|
|
17589
|
+
|
|
17590
|
+
[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/undici/formdata](../index.md) / IItem
|
|
17591
|
+
|
|
17592
|
+
# Type Alias: IItem
|
|
17593
|
+
|
|
17594
|
+
> **IItem** = \{ `key`: `string`; `path`: `""`; `type`: `"string"`; `value`: `string`; \} \| \{ `key`: `string`; `path`: `string`; `type`: `"file"`; `value`: `string`; \} \| \{ `key`: `string`; `path`: `Buffer`; `type`: `"buffer"`; `value`: `string`; \}
|
|
17595
|
+
|
|
17596
|
+
Defined in: [lib/undici/formdata.ts:12](https://github.com/maiyunnet/kebab/blob/master/lib/undici/formdata.ts#L12)
|
|
17597
|
+
|
|
17598
|
+
Item 对象
|
|
17599
|
+
|
|
17600
|
+
## Union Members
|
|
17601
|
+
|
|
17602
|
+
### Type Literal
|
|
17603
|
+
|
|
17604
|
+
\{ `key`: `string`; `path`: `""`; `type`: `"string"`; `value`: `string`; \}
|
|
17605
|
+
|
|
17606
|
+
#### key
|
|
17607
|
+
|
|
17608
|
+
> **key**: `string`
|
|
17609
|
+
|
|
17610
|
+
key 键
|
|
17611
|
+
|
|
17612
|
+
#### path
|
|
17613
|
+
|
|
17614
|
+
> **path**: `""`
|
|
17615
|
+
|
|
17616
|
+
#### type
|
|
17617
|
+
|
|
17618
|
+
> **type**: `"string"`
|
|
17619
|
+
|
|
17620
|
+
#### value
|
|
17621
|
+
|
|
17622
|
+
> **value**: `string`
|
|
17623
|
+
|
|
17624
|
+
字符串值
|
|
17625
|
+
|
|
17626
|
+
***
|
|
17627
|
+
|
|
17628
|
+
### Type Literal
|
|
17629
|
+
|
|
17630
|
+
\{ `key`: `string`; `path`: `string`; `type`: `"file"`; `value`: `string`; \}
|
|
17631
|
+
|
|
17632
|
+
#### key
|
|
17633
|
+
|
|
17634
|
+
> **key**: `string`
|
|
17635
|
+
|
|
17636
|
+
key 键
|
|
17637
|
+
|
|
17638
|
+
#### path
|
|
17639
|
+
|
|
17640
|
+
> **path**: `string`
|
|
17641
|
+
|
|
17642
|
+
文件路径
|
|
17643
|
+
|
|
17644
|
+
#### type
|
|
17645
|
+
|
|
17646
|
+
> **type**: `"file"`
|
|
17647
|
+
|
|
17648
|
+
#### value
|
|
17649
|
+
|
|
17650
|
+
> **value**: `string`
|
|
17651
|
+
|
|
17652
|
+
文件名
|
|
17653
|
+
|
|
17654
|
+
***
|
|
17655
|
+
|
|
17656
|
+
### Type Literal
|
|
17657
|
+
|
|
17658
|
+
\{ `key`: `string`; `path`: `Buffer`; `type`: `"buffer"`; `value`: `string`; \}
|
|
17659
|
+
|
|
17660
|
+
#### key
|
|
17661
|
+
|
|
17662
|
+
> **key**: `string`
|
|
17663
|
+
|
|
17664
|
+
key 键
|
|
17665
|
+
|
|
17666
|
+
#### path
|
|
17667
|
+
|
|
17668
|
+
> **path**: `Buffer`
|
|
17669
|
+
|
|
17670
|
+
Buffer 数据
|
|
17671
|
+
|
|
17672
|
+
#### type
|
|
17673
|
+
|
|
17674
|
+
> **type**: `"buffer"`
|
|
17675
|
+
|
|
17676
|
+
#### value
|
|
17677
|
+
|
|
17678
|
+
> **value**: `string`
|
|
17679
|
+
|
|
17680
|
+
文件名
|
|
17681
|
+
|
|
17682
|
+
lib/undici/functions/fetch.md
|
|
17683
|
+
---
|
|
17684
|
+
|
|
17685
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17686
|
+
|
|
17687
|
+
***
|
|
17688
|
+
|
|
17689
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / fetch
|
|
17690
|
+
|
|
17691
|
+
# Function: fetch()
|
|
17692
|
+
|
|
17693
|
+
> **fetch**(`input`, `init?`): `Promise`\<`Response`\>
|
|
17694
|
+
|
|
17695
|
+
Defined in: [lib/undici.ts:158](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L158)
|
|
17696
|
+
|
|
17697
|
+
发起一个完全兼容 fetch 的请求
|
|
17698
|
+
|
|
17699
|
+
## Parameters
|
|
17700
|
+
|
|
17701
|
+
### input
|
|
17702
|
+
|
|
17703
|
+
`string` \| `Request` \| `URL`
|
|
17704
|
+
|
|
17705
|
+
请求的 URL 或 Request 对象
|
|
17706
|
+
|
|
17707
|
+
### init?
|
|
17708
|
+
|
|
17709
|
+
`RequestInit` & `object` = `{}`
|
|
17710
|
+
|
|
17711
|
+
增加 mproxy、hosts
|
|
17712
|
+
|
|
17713
|
+
## Returns
|
|
17714
|
+
|
|
17715
|
+
`Promise`\<`Response`\>
|
|
17716
|
+
|
|
17717
|
+
lib/undici/functions/filterHeaders.md
|
|
17718
|
+
---
|
|
17719
|
+
|
|
17720
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17721
|
+
|
|
17722
|
+
***
|
|
17723
|
+
|
|
17724
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / filterHeaders
|
|
17725
|
+
|
|
17726
|
+
# Function: filterHeaders()
|
|
17727
|
+
|
|
17728
|
+
> **filterHeaders**(`headers`, `res?`, `filter?`): `Record`\<`string`, `string` \| `string`[]\>
|
|
17729
|
+
|
|
17730
|
+
Defined in: [lib/undici.ts:513](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L513)
|
|
17731
|
+
|
|
17732
|
+
剔除不代理的 header,返回新的 header
|
|
17733
|
+
|
|
17734
|
+
## Parameters
|
|
17735
|
+
|
|
17736
|
+
### headers
|
|
17737
|
+
|
|
17738
|
+
`IncomingHttpHeaders` \| `IncomingHttpHeaders` \| [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
17739
|
+
|
|
17740
|
+
剔除前的 header
|
|
17741
|
+
|
|
17742
|
+
### res?
|
|
17743
|
+
|
|
17744
|
+
`Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
|
|
17745
|
+
|
|
17746
|
+
直接设置头部而不返回,可置空
|
|
17747
|
+
|
|
17748
|
+
### filter?
|
|
17749
|
+
|
|
17750
|
+
(`h`) => `boolean`
|
|
17751
|
+
|
|
17752
|
+
返回 true 则留下
|
|
17753
|
+
|
|
17754
|
+
## Returns
|
|
17755
|
+
|
|
17756
|
+
`Record`\<`string`, `string` \| `string`[]\>
|
|
17757
|
+
|
|
17758
|
+
lib/undici/functions/getFormData.md
|
|
17759
|
+
---
|
|
17760
|
+
|
|
17761
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17762
|
+
|
|
17763
|
+
***
|
|
17764
|
+
|
|
17765
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / getFormData
|
|
17766
|
+
|
|
17767
|
+
# Function: getFormData()
|
|
17768
|
+
|
|
17769
|
+
> **getFormData**(): [`FormData`](../formdata/classes/FormData.md)
|
|
17770
|
+
|
|
17771
|
+
Defined in: [lib/undici.ts:497](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L497)
|
|
17772
|
+
|
|
17773
|
+
创建 FormData 对象
|
|
17774
|
+
|
|
17775
|
+
## Returns
|
|
17776
|
+
|
|
17777
|
+
[`FormData`](../formdata/classes/FormData.md)
|
|
17778
|
+
|
|
17779
|
+
lib/undici/functions/get.md
|
|
17780
|
+
---
|
|
17781
|
+
|
|
17782
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17783
|
+
|
|
17784
|
+
***
|
|
17785
|
+
|
|
17786
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / get
|
|
17787
|
+
|
|
17788
|
+
# Function: get()
|
|
17789
|
+
|
|
17790
|
+
> **get**(`u`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
17791
|
+
|
|
17792
|
+
Defined in: [lib/undici.ts:72](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L72)
|
|
17793
|
+
|
|
17794
|
+
发起一个 get 请求
|
|
17795
|
+
|
|
17796
|
+
## Parameters
|
|
17797
|
+
|
|
17798
|
+
### u
|
|
17799
|
+
|
|
17800
|
+
`string`
|
|
17801
|
+
|
|
17802
|
+
请求的 URL
|
|
17803
|
+
|
|
17804
|
+
### opt?
|
|
17805
|
+
|
|
17806
|
+
[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
|
|
17807
|
+
|
|
17808
|
+
参数
|
|
17809
|
+
|
|
17810
|
+
## Returns
|
|
17811
|
+
|
|
17812
|
+
`Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
17813
|
+
|
|
17814
|
+
lib/undici/functions/getProxyAgent.md
|
|
17815
|
+
---
|
|
17816
|
+
|
|
17817
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17818
|
+
|
|
17819
|
+
***
|
|
17820
|
+
|
|
17821
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / getProxyAgent
|
|
17822
|
+
|
|
17823
|
+
# Function: getProxyAgent()
|
|
17824
|
+
|
|
17825
|
+
> **getProxyAgent**(`url`): `ProxyAgent`
|
|
17826
|
+
|
|
17827
|
+
Defined in: [lib/undici.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L19)
|
|
17828
|
+
|
|
17829
|
+
获取代理 agent
|
|
17830
|
+
|
|
17831
|
+
## Parameters
|
|
17832
|
+
|
|
17833
|
+
### url
|
|
17834
|
+
|
|
17835
|
+
`string`
|
|
17836
|
+
|
|
17837
|
+
## Returns
|
|
17838
|
+
|
|
17839
|
+
`ProxyAgent`
|
|
17840
|
+
|
|
17841
|
+
lib/undici/functions/getResponseJson.md
|
|
17842
|
+
---
|
|
17843
|
+
|
|
17844
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17845
|
+
|
|
17846
|
+
***
|
|
17847
|
+
|
|
17848
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / getResponseJson
|
|
17849
|
+
|
|
17850
|
+
# Function: getResponseJson()
|
|
17851
|
+
|
|
17852
|
+
> **getResponseJson**(`u`, `opt?`): `Promise`\<`any`\>
|
|
17853
|
+
|
|
17854
|
+
Defined in: [lib/undici.ts:137](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L137)
|
|
17855
|
+
|
|
17856
|
+
发起 GET 请求并解析 JSON 响应
|
|
17857
|
+
|
|
17858
|
+
## Parameters
|
|
17859
|
+
|
|
17860
|
+
### u
|
|
17861
|
+
|
|
17862
|
+
`string`
|
|
17863
|
+
|
|
17864
|
+
网址
|
|
17865
|
+
|
|
17866
|
+
### opt?
|
|
17867
|
+
|
|
17868
|
+
[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
|
|
17869
|
+
|
|
17870
|
+
选项
|
|
17871
|
+
|
|
17872
|
+
## Returns
|
|
17873
|
+
|
|
17874
|
+
`Promise`\<`any`\>
|
|
17875
|
+
|
|
17876
|
+
JSON 数据,失败时返回 null
|
|
17877
|
+
|
|
17878
|
+
lib/undici/functions/mproxyData.md
|
|
17879
|
+
---
|
|
17880
|
+
|
|
17881
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17882
|
+
|
|
17883
|
+
***
|
|
17884
|
+
|
|
17885
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / mproxyData
|
|
17886
|
+
|
|
17887
|
+
# Function: mproxyData()
|
|
17888
|
+
|
|
17889
|
+
> **mproxyData**(`ctr`): `any`
|
|
17890
|
+
|
|
17891
|
+
Defined in: [lib/undici.ts:601](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L601)
|
|
17892
|
+
|
|
17893
|
+
获取 mproxy 的附加数据
|
|
17894
|
+
|
|
17895
|
+
## Parameters
|
|
17896
|
+
|
|
17897
|
+
### ctr
|
|
17898
|
+
|
|
17899
|
+
[`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
17900
|
+
|
|
17901
|
+
当前控制器
|
|
17902
|
+
|
|
17903
|
+
## Returns
|
|
17904
|
+
|
|
17905
|
+
`any`
|
|
17906
|
+
|
|
17907
|
+
lib/undici/functions/mproxy.md
|
|
17908
|
+
---
|
|
17909
|
+
|
|
17910
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17911
|
+
|
|
17912
|
+
***
|
|
17913
|
+
|
|
17914
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / mproxy
|
|
17915
|
+
|
|
17916
|
+
# Function: mproxy()
|
|
17917
|
+
|
|
17918
|
+
> **mproxy**(`ctr`, `auth`, `opt?`): `Promise`\<`number`\>
|
|
17919
|
+
|
|
17920
|
+
Defined in: [lib/undici.ts:549](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L549)
|
|
17921
|
+
|
|
17922
|
+
正向 mproxy 代理,注意提前处理不要自动处理 post 数据,读取 get 的 url 为实际请求地址
|
|
17923
|
+
get: url, auth
|
|
17924
|
+
|
|
17925
|
+
## Parameters
|
|
17926
|
+
|
|
17927
|
+
### ctr
|
|
17928
|
+
|
|
17929
|
+
[`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
17930
|
+
|
|
17931
|
+
当前控制器
|
|
17932
|
+
|
|
17933
|
+
### auth
|
|
17934
|
+
|
|
17935
|
+
`string`
|
|
17936
|
+
|
|
17937
|
+
校验字符串,读取 get 的 auth 和本参数做比对
|
|
17938
|
+
|
|
17939
|
+
### opt?
|
|
17940
|
+
|
|
17941
|
+
[`IMproxyOptions`](../interfaces/IMproxyOptions.md) = `{}`
|
|
17942
|
+
|
|
17943
|
+
参数
|
|
17944
|
+
|
|
17945
|
+
## Returns
|
|
17946
|
+
|
|
17947
|
+
`Promise`\<`number`\>
|
|
17948
|
+
|
|
17949
|
+
lib/undici/functions/open.md
|
|
17950
|
+
---
|
|
17951
|
+
|
|
17952
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17953
|
+
|
|
17954
|
+
***
|
|
17955
|
+
|
|
17956
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / open
|
|
17957
|
+
|
|
17958
|
+
# Function: open()
|
|
17959
|
+
|
|
17960
|
+
> **open**(`u`): [`Request`](../request/classes/Request.md)
|
|
17961
|
+
|
|
17962
|
+
Defined in: [lib/undici.ts:63](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L63)
|
|
17963
|
+
|
|
17964
|
+
创建一个请求对象
|
|
17965
|
+
|
|
17966
|
+
## Parameters
|
|
17967
|
+
|
|
17968
|
+
### u
|
|
17969
|
+
|
|
17970
|
+
`string`
|
|
17971
|
+
|
|
17972
|
+
## Returns
|
|
17973
|
+
|
|
17974
|
+
[`Request`](../request/classes/Request.md)
|
|
17975
|
+
|
|
17976
|
+
lib/undici/functions/postJson.md
|
|
17977
|
+
---
|
|
17978
|
+
|
|
17979
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17980
|
+
|
|
17981
|
+
***
|
|
17982
|
+
|
|
17983
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / postJson
|
|
17984
|
+
|
|
17985
|
+
# Function: postJson()
|
|
17986
|
+
|
|
17987
|
+
> **postJson**(`u`, `data`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
17988
|
+
|
|
17989
|
+
Defined in: [lib/undici.ts:97](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L97)
|
|
17990
|
+
|
|
17991
|
+
发起 JSON 请求
|
|
17992
|
+
|
|
17993
|
+
## Parameters
|
|
17994
|
+
|
|
17995
|
+
### u
|
|
17996
|
+
|
|
17997
|
+
`string`
|
|
17998
|
+
|
|
17999
|
+
网址
|
|
18000
|
+
|
|
18001
|
+
### data
|
|
18002
|
+
|
|
18003
|
+
`any`[] \| `Record`\<`string`, `any`\>
|
|
18004
|
+
|
|
18005
|
+
数据
|
|
18006
|
+
|
|
18007
|
+
### opt?
|
|
18008
|
+
|
|
18009
|
+
[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
|
|
18010
|
+
|
|
18011
|
+
选项
|
|
18012
|
+
|
|
18013
|
+
## Returns
|
|
18014
|
+
|
|
18015
|
+
`Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
18016
|
+
|
|
18017
|
+
lib/undici/functions/postJsonResponseJson.md
|
|
18018
|
+
---
|
|
18019
|
+
|
|
18020
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
18021
|
+
|
|
18022
|
+
***
|
|
18023
|
+
|
|
18024
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / postJsonResponseJson
|
|
18025
|
+
|
|
18026
|
+
# Function: postJsonResponseJson()
|
|
18027
|
+
|
|
18028
|
+
> **postJsonResponseJson**(`u`, `data`, `opt?`): `Promise`\<`any`\>
|
|
18029
|
+
|
|
18030
|
+
Defined in: [lib/undici.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L114)
|
|
18031
|
+
|
|
18032
|
+
发起 JSON 请求并解析 JSON 响应
|
|
18033
|
+
|
|
18034
|
+
## Parameters
|
|
18035
|
+
|
|
18036
|
+
### u
|
|
18037
|
+
|
|
18038
|
+
`string`
|
|
18039
|
+
|
|
18040
|
+
网址
|
|
18041
|
+
|
|
18042
|
+
### data
|
|
18043
|
+
|
|
18044
|
+
`any`[] \| `Record`\<`string`, `any`\>
|
|
18045
|
+
|
|
18046
|
+
数据
|
|
18047
|
+
|
|
18048
|
+
### opt?
|
|
18049
|
+
|
|
18050
|
+
[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
|
|
18051
|
+
|
|
18052
|
+
选项
|
|
18053
|
+
|
|
18054
|
+
## Returns
|
|
18055
|
+
|
|
18056
|
+
`Promise`\<`any`\>
|
|
18057
|
+
|
|
18058
|
+
JSON 数据,失败时返回 null
|
|
18059
|
+
|
|
18060
|
+
lib/undici/functions/post.md
|
|
18061
|
+
---
|
|
18062
|
+
|
|
18063
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
18064
|
+
|
|
18065
|
+
***
|
|
18066
|
+
|
|
18067
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / post
|
|
18068
|
+
|
|
18069
|
+
# Function: post()
|
|
18070
|
+
|
|
18071
|
+
> **post**(`u`, `data`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
18072
|
+
|
|
18073
|
+
Defined in: [lib/undici.ts:82](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L82)
|
|
18074
|
+
|
|
18075
|
+
发起一个 post 请求
|
|
18076
|
+
|
|
18077
|
+
## Parameters
|
|
18078
|
+
|
|
18079
|
+
### u
|
|
18080
|
+
|
|
18081
|
+
`string`
|
|
18082
|
+
|
|
18083
|
+
请求的 URL
|
|
18084
|
+
|
|
18085
|
+
### data
|
|
18086
|
+
|
|
18087
|
+
`string` \| `Record`\<`string`, `any`\> \| `Buffer`\<`ArrayBufferLike`\> \| `Readable`
|
|
18088
|
+
|
|
18089
|
+
要发送的数据
|
|
18090
|
+
|
|
18091
|
+
### opt?
|
|
18092
|
+
|
|
18093
|
+
[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
|
|
18094
|
+
|
|
18095
|
+
参数
|
|
18096
|
+
|
|
18097
|
+
## Returns
|
|
18098
|
+
|
|
18099
|
+
`Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
18100
|
+
|
|
18101
|
+
lib/undici/functions/request.md
|
|
18102
|
+
---
|
|
18103
|
+
|
|
18104
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
18105
|
+
|
|
18106
|
+
***
|
|
18107
|
+
|
|
18108
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / request
|
|
18109
|
+
|
|
18110
|
+
# Function: request()
|
|
18111
|
+
|
|
18112
|
+
> **request**(`u`, `data?`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
18113
|
+
|
|
18114
|
+
Defined in: [lib/undici.ts:327](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L327)
|
|
18115
|
+
|
|
18116
|
+
发起一个请求
|
|
18117
|
+
|
|
18118
|
+
## Parameters
|
|
18119
|
+
|
|
18120
|
+
### u
|
|
18121
|
+
|
|
18122
|
+
`string`
|
|
18123
|
+
|
|
18124
|
+
### data?
|
|
18125
|
+
|
|
18126
|
+
`string` \| `Record`\<`string`, `any`\> \| `Buffer`\<`ArrayBufferLike`\> \| `Readable`
|
|
18127
|
+
|
|
18128
|
+
### opt?
|
|
18129
|
+
|
|
18130
|
+
[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
|
|
18131
|
+
|
|
18132
|
+
配置项
|
|
18133
|
+
|
|
18134
|
+
## Returns
|
|
18135
|
+
|
|
18136
|
+
`Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
18137
|
+
|
|
18138
|
+
lib/undici/functions/rproxy.md
|
|
18139
|
+
---
|
|
18140
|
+
|
|
18141
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
18142
|
+
|
|
18143
|
+
***
|
|
18144
|
+
|
|
18145
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / rproxy
|
|
18146
|
+
|
|
18147
|
+
# Function: rproxy()
|
|
18148
|
+
|
|
18149
|
+
> **rproxy**(`ctr`, `route`, `opt?`): `Promise`\<`boolean`\>
|
|
18150
|
+
|
|
18151
|
+
Defined in: [lib/undici.ts:619](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L619)
|
|
18152
|
+
|
|
18153
|
+
反向代理,注意提前处理不要自动处理 post 数据,将本服务器的某个路由反代到其他网址
|
|
18154
|
+
|
|
18155
|
+
## Parameters
|
|
18156
|
+
|
|
18157
|
+
### ctr
|
|
18158
|
+
|
|
18159
|
+
[`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
18160
|
+
|
|
18161
|
+
当前控制器
|
|
18162
|
+
|
|
18163
|
+
### route
|
|
18164
|
+
|
|
18165
|
+
`Record`\<`string`, `string`\>
|
|
18166
|
+
|
|
18167
|
+
要反代的路由
|
|
18168
|
+
|
|
18169
|
+
### opt?
|
|
18170
|
+
|
|
18171
|
+
[`IRproxyOptions`](../interfaces/IRproxyOptions.md) = `{}`
|
|
18172
|
+
|
|
18173
|
+
参数
|
|
18174
|
+
|
|
18175
|
+
## Returns
|
|
18176
|
+
|
|
18177
|
+
`Promise`\<`boolean`\>
|
|
18178
|
+
|
|
18179
|
+
lib/undici/index.md
|
|
18180
|
+
---
|
|
18181
|
+
|
|
18182
|
+
[**Documents for @maiyunnet/kebab**](../../index.md)
|
|
18183
|
+
|
|
18184
|
+
***
|
|
18185
|
+
|
|
18186
|
+
[Documents for @maiyunnet/kebab](../../index.md) / lib/undici
|
|
18187
|
+
|
|
18188
|
+
# lib/undici
|
|
18189
|
+
|
|
18190
|
+
## Interfaces
|
|
18191
|
+
|
|
18192
|
+
- [IMproxyOptions](interfaces/IMproxyOptions.md)
|
|
18193
|
+
- [IRequestOptions](interfaces/IRequestOptions.md)
|
|
18194
|
+
- [IRproxyOptions](interfaces/IRproxyOptions.md)
|
|
18195
|
+
|
|
18196
|
+
## Type Aliases
|
|
18197
|
+
|
|
18198
|
+
- [THttpHeaders](type-aliases/THttpHeaders.md)
|
|
18199
|
+
|
|
18200
|
+
## Functions
|
|
18201
|
+
|
|
18202
|
+
- [fetch](functions/fetch.md)
|
|
18203
|
+
- [filterHeaders](functions/filterHeaders.md)
|
|
18204
|
+
- [get](functions/get.md)
|
|
18205
|
+
- [getFormData](functions/getFormData.md)
|
|
18206
|
+
- [getProxyAgent](functions/getProxyAgent.md)
|
|
18207
|
+
- [getResponseJson](functions/getResponseJson.md)
|
|
18208
|
+
- [mproxy](functions/mproxy.md)
|
|
18209
|
+
- [mproxyData](functions/mproxyData.md)
|
|
18210
|
+
- [open](functions/open.md)
|
|
18211
|
+
- [post](functions/post.md)
|
|
18212
|
+
- [postJson](functions/postJson.md)
|
|
18213
|
+
- [postJsonResponseJson](functions/postJsonResponseJson.md)
|
|
18214
|
+
- [request](functions/request.md)
|
|
18215
|
+
- [rproxy](functions/rproxy.md)
|
|
18216
|
+
|
|
18217
|
+
lib/undici/interfaces/IMproxyOptions.md
|
|
18218
|
+
---
|
|
18219
|
+
|
|
18220
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
18221
|
+
|
|
18222
|
+
***
|
|
18223
|
+
|
|
18224
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / IMproxyOptions
|
|
18225
|
+
|
|
18226
|
+
# Interface: IMproxyOptions
|
|
18227
|
+
|
|
18228
|
+
Defined in: [lib/undici.ts:703](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L703)
|
|
18229
|
+
|
|
18230
|
+
正向代理请求的传入参数选项
|
|
18231
|
+
|
|
18232
|
+
## Properties
|
|
18233
|
+
|
|
18234
|
+
### filter?
|
|
18235
|
+
|
|
18236
|
+
> `optional` **filter?**: (`h`) => `boolean`
|
|
18237
|
+
|
|
18238
|
+
Defined in: [lib/undici.ts:712](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L712)
|
|
18239
|
+
|
|
18240
|
+
过滤 header,返回 true 则留下
|
|
18241
|
+
|
|
18242
|
+
#### Parameters
|
|
18243
|
+
|
|
18244
|
+
##### h
|
|
18245
|
+
|
|
18246
|
+
`string`
|
|
18247
|
+
|
|
18248
|
+
#### Returns
|
|
18249
|
+
|
|
18250
|
+
`boolean`
|
|
18251
|
+
|
|
18252
|
+
***
|
|
18253
|
+
|
|
18254
|
+
### follow?
|
|
18255
|
+
|
|
18256
|
+
> `optional` **follow?**: `number`
|
|
18257
|
+
|
|
18258
|
+
Defined in: [lib/undici.ts:706](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L706)
|
|
18259
|
+
|
|
18260
|
+
***
|
|
18261
|
+
|
|
18262
|
+
### headers?
|
|
18263
|
+
|
|
18264
|
+
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
18265
|
+
|
|
18266
|
+
Defined in: [lib/undici.ts:710](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L710)
|
|
18267
|
+
|
|
18268
|
+
***
|
|
18269
|
+
|
|
18270
|
+
### hosts?
|
|
18271
|
+
|
|
18272
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
18273
|
+
|
|
18274
|
+
Defined in: [lib/undici.ts:708](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L708)
|
|
18275
|
+
|
|
18276
|
+
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
18277
|
+
|
|
18278
|
+
***
|
|
18279
|
+
|
|
18280
|
+
### local?
|
|
18281
|
+
|
|
18282
|
+
> `optional` **local?**: `string`
|
|
18283
|
+
|
|
18284
|
+
Defined in: [lib/undici.ts:709](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L709)
|
|
18285
|
+
|
|
18286
|
+
***
|
|
18287
|
+
|
|
18288
|
+
### reuse?
|
|
18289
|
+
|
|
18290
|
+
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
18291
|
+
|
|
18292
|
+
Defined in: [lib/undici.ts:714](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L714)
|
|
18293
|
+
|
|
18294
|
+
默认为 default
|
|
18295
|
+
|
|
18296
|
+
***
|
|
18297
|
+
|
|
18298
|
+
### timeout?
|
|
18299
|
+
|
|
18300
|
+
> `optional` **timeout?**: `number`
|
|
18301
|
+
|
|
18302
|
+
Defined in: [lib/undici.ts:705](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L705)
|
|
18303
|
+
|
|
18304
|
+
秒数
|
|
18305
|
+
|
|
18306
|
+
lib/undici/interfaces/IRequestOptions.md
|
|
18307
|
+
---
|
|
18308
|
+
|
|
18309
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
18310
|
+
|
|
18311
|
+
***
|
|
18312
|
+
|
|
18313
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / IRequestOptions
|
|
18314
|
+
|
|
18315
|
+
# Interface: IRequestOptions
|
|
18316
|
+
|
|
18317
|
+
Defined in: [lib/undici.ts:672](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L672)
|
|
18318
|
+
|
|
18319
|
+
请求的传入参数选项
|
|
18320
|
+
|
|
18321
|
+
## Properties
|
|
18322
|
+
|
|
18323
|
+
### cookie?
|
|
18324
|
+
|
|
18325
|
+
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../cookie/interfaces/ICookie.md)\>
|
|
18326
|
+
|
|
18327
|
+
Defined in: [lib/undici.ts:697](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L697)
|
|
18328
|
+
|
|
18329
|
+
cookie 托管对象
|
|
18330
|
+
|
|
18331
|
+
***
|
|
18332
|
+
|
|
18333
|
+
### follow?
|
|
18334
|
+
|
|
18335
|
+
> `optional` **follow?**: `number`
|
|
18336
|
+
|
|
18337
|
+
Defined in: [lib/undici.ts:678](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L678)
|
|
18338
|
+
|
|
18339
|
+
追踪 location 次数,0 为不追踪,默认为 0
|
|
18340
|
+
|
|
18341
|
+
***
|
|
18342
|
+
|
|
18343
|
+
### headers?
|
|
18344
|
+
|
|
18345
|
+
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
18346
|
+
|
|
18347
|
+
Defined in: [lib/undici.ts:683](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L683)
|
|
18348
|
+
|
|
18349
|
+
***
|
|
18350
|
+
|
|
18351
|
+
### hosts?
|
|
18352
|
+
|
|
18353
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
18354
|
+
|
|
18355
|
+
Defined in: [lib/undici.ts:680](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L680)
|
|
18356
|
+
|
|
18357
|
+
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
18358
|
+
|
|
18359
|
+
***
|
|
18360
|
+
|
|
18361
|
+
### keep?
|
|
18362
|
+
|
|
18363
|
+
> `optional` **keep?**: `boolean`
|
|
18364
|
+
|
|
18365
|
+
Defined in: [lib/undici.ts:693](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L693)
|
|
18366
|
+
|
|
18367
|
+
连接是否保持长连接(即是否允许复用),默认为 true
|
|
18368
|
+
|
|
18369
|
+
***
|
|
18370
|
+
|
|
18371
|
+
### local?
|
|
18372
|
+
|
|
18373
|
+
> `optional` **local?**: `string`
|
|
18374
|
+
|
|
18375
|
+
Defined in: [lib/undici.ts:682](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L682)
|
|
18376
|
+
|
|
18377
|
+
***
|
|
18378
|
+
|
|
18379
|
+
### log?
|
|
18380
|
+
|
|
18381
|
+
> `optional` **log?**: `boolean`
|
|
18382
|
+
|
|
18383
|
+
Defined in: [lib/undici.ts:699](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L699)
|
|
18384
|
+
|
|
18385
|
+
若有异常写入文件日志,默认为 true
|
|
18386
|
+
|
|
18387
|
+
***
|
|
18388
|
+
|
|
18389
|
+
### method?
|
|
18390
|
+
|
|
18391
|
+
> `optional` **method?**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"OPTIONS"`
|
|
18392
|
+
|
|
18393
|
+
Defined in: [lib/undici.ts:673](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L673)
|
|
18394
|
+
|
|
18395
|
+
***
|
|
18396
|
+
|
|
18397
|
+
### mproxy?
|
|
18398
|
+
|
|
18399
|
+
> `optional` **mproxy?**: `object`
|
|
18400
|
+
|
|
18401
|
+
Defined in: [lib/undici.ts:685](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L685)
|
|
18402
|
+
|
|
18403
|
+
正向 mproxy 代理,url 如 https://xxx/abc
|
|
18404
|
+
|
|
18405
|
+
#### auth
|
|
18406
|
+
|
|
18407
|
+
> **auth**: `string`
|
|
18408
|
+
|
|
18409
|
+
#### data?
|
|
18410
|
+
|
|
18411
|
+
> `optional` **data?**: `any`
|
|
18412
|
+
|
|
18413
|
+
#### hosts?
|
|
18414
|
+
|
|
18415
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
18416
|
+
|
|
18417
|
+
落地端自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
18418
|
+
|
|
18419
|
+
#### url
|
|
18420
|
+
|
|
18421
|
+
> **url**: `string`
|
|
18422
|
+
|
|
18423
|
+
***
|
|
18424
|
+
|
|
18425
|
+
### reuse?
|
|
18426
|
+
|
|
18427
|
+
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
18428
|
+
|
|
18429
|
+
Defined in: [lib/undici.ts:695](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L695)
|
|
18430
|
+
|
|
18431
|
+
复用池名/Agent,默认为 default
|
|
18432
|
+
|
|
18433
|
+
***
|
|
18434
|
+
|
|
18435
|
+
### save?
|
|
18436
|
+
|
|
18437
|
+
> `optional` **save?**: `string`
|
|
18438
|
+
|
|
18439
|
+
Defined in: [lib/undici.ts:681](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L681)
|
|
18440
|
+
|
|
18441
|
+
***
|
|
18442
|
+
|
|
18443
|
+
### timeout?
|
|
18444
|
+
|
|
18445
|
+
> `optional` **timeout?**: `number`
|
|
18446
|
+
|
|
18447
|
+
Defined in: [lib/undici.ts:676](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L676)
|
|
18448
|
+
|
|
18449
|
+
秒数,默认 10 秒
|
|
18450
|
+
|
|
18451
|
+
***
|
|
18452
|
+
|
|
18453
|
+
### type?
|
|
18454
|
+
|
|
18455
|
+
> `optional` **type?**: `"form"` \| `"json"`
|
|
18456
|
+
|
|
18457
|
+
Defined in: [lib/undici.ts:674](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L674)
|
|
18458
|
+
|
|
18459
|
+
lib/undici/interfaces/IRproxyOptions.md
|
|
18460
|
+
---
|
|
18461
|
+
|
|
18462
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
18463
|
+
|
|
18464
|
+
***
|
|
18465
|
+
|
|
18466
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / IRproxyOptions
|
|
18467
|
+
|
|
18468
|
+
# Interface: IRproxyOptions
|
|
18469
|
+
|
|
18470
|
+
Defined in: [lib/undici.ts:718](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L718)
|
|
18471
|
+
|
|
18472
|
+
反向代理请求的传入参数选项
|
|
18473
|
+
|
|
18474
|
+
## Properties
|
|
18475
|
+
|
|
18476
|
+
### filter?
|
|
18477
|
+
|
|
18478
|
+
> `optional` **filter?**: (`h`) => `boolean`
|
|
18479
|
+
|
|
18480
|
+
Defined in: [lib/undici.ts:727](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L727)
|
|
18481
|
+
|
|
18482
|
+
过滤 header,返回 true 则留下
|
|
18483
|
+
|
|
18484
|
+
#### Parameters
|
|
18485
|
+
|
|
18486
|
+
##### h
|
|
18487
|
+
|
|
18488
|
+
`string`
|
|
18489
|
+
|
|
18490
|
+
#### Returns
|
|
18491
|
+
|
|
18492
|
+
`boolean`
|
|
18493
|
+
|
|
18494
|
+
***
|
|
18495
|
+
|
|
18496
|
+
### follow?
|
|
18497
|
+
|
|
18498
|
+
> `optional` **follow?**: `number`
|
|
18499
|
+
|
|
18500
|
+
Defined in: [lib/undici.ts:721](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L721)
|
|
18501
|
+
|
|
18502
|
+
***
|
|
18503
|
+
|
|
18504
|
+
### headers?
|
|
18505
|
+
|
|
18506
|
+
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
18507
|
+
|
|
18508
|
+
Defined in: [lib/undici.ts:725](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L725)
|
|
18509
|
+
|
|
18510
|
+
***
|
|
18511
|
+
|
|
18512
|
+
### hosts?
|
|
18513
|
+
|
|
18514
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
18515
|
+
|
|
18516
|
+
Defined in: [lib/undici.ts:723](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L723)
|
|
18517
|
+
|
|
18518
|
+
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
18519
|
+
|
|
18520
|
+
***
|
|
18521
|
+
|
|
18522
|
+
### local?
|
|
18523
|
+
|
|
18524
|
+
> `optional` **local?**: `string`
|
|
18525
|
+
|
|
18526
|
+
Defined in: [lib/undici.ts:724](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L724)
|
|
18527
|
+
|
|
18528
|
+
***
|
|
18529
|
+
|
|
18530
|
+
### mproxy?
|
|
18531
|
+
|
|
18532
|
+
> `optional` **mproxy?**: `object`
|
|
18533
|
+
|
|
18534
|
+
Defined in: [lib/undici.ts:729](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L729)
|
|
18535
|
+
|
|
18536
|
+
正向 mproxy 代理,url 如 https://xxx/abc
|
|
18537
|
+
|
|
18538
|
+
#### auth
|
|
18539
|
+
|
|
18540
|
+
> **auth**: `string`
|
|
18541
|
+
|
|
18542
|
+
#### data?
|
|
18543
|
+
|
|
18544
|
+
> `optional` **data?**: `any`
|
|
18545
|
+
|
|
18546
|
+
#### hosts?
|
|
18547
|
+
|
|
18548
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
18549
|
+
|
|
18550
|
+
落地端自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
18551
|
+
|
|
18552
|
+
#### url
|
|
18553
|
+
|
|
18554
|
+
> **url**: `string`
|
|
18555
|
+
|
|
18556
|
+
***
|
|
18557
|
+
|
|
18558
|
+
### reuse?
|
|
18559
|
+
|
|
18560
|
+
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
18561
|
+
|
|
18562
|
+
Defined in: [lib/undici.ts:737](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L737)
|
|
18563
|
+
|
|
18564
|
+
默认为 default
|
|
18565
|
+
|
|
18566
|
+
***
|
|
18567
|
+
|
|
18568
|
+
### timeout?
|
|
18569
|
+
|
|
18570
|
+
> `optional` **timeout?**: `number`
|
|
18571
|
+
|
|
18572
|
+
Defined in: [lib/undici.ts:720](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L720)
|
|
18573
|
+
|
|
18574
|
+
秒数
|
|
18575
|
+
|
|
18576
|
+
lib/undici/request/classes/Request.md
|
|
18577
|
+
---
|
|
18578
|
+
|
|
18579
|
+
[**Documents for @maiyunnet/kebab**](../../../../index.md)
|
|
18580
|
+
|
|
18581
|
+
***
|
|
18582
|
+
|
|
18583
|
+
[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/undici/request](../index.md) / Request
|
|
18584
|
+
|
|
18585
|
+
# Class: Request
|
|
18586
|
+
|
|
18587
|
+
Defined in: [lib/undici/request.ts:11](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L11)
|
|
18588
|
+
|
|
18589
|
+
## Constructors
|
|
18590
|
+
|
|
18591
|
+
### Constructor
|
|
18592
|
+
|
|
18593
|
+
> **new Request**(`url`): `Request`
|
|
18594
|
+
|
|
18595
|
+
Defined in: [lib/undici/request.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L22)
|
|
18596
|
+
|
|
18597
|
+
#### Parameters
|
|
18598
|
+
|
|
18599
|
+
##### url
|
|
18600
|
+
|
|
18601
|
+
`string`
|
|
18602
|
+
|
|
18603
|
+
#### Returns
|
|
18604
|
+
|
|
18605
|
+
`Request`
|
|
18606
|
+
|
|
18607
|
+
## Methods
|
|
18608
|
+
|
|
18609
|
+
### data()
|
|
18610
|
+
|
|
18611
|
+
> **data**(`data`): `this`
|
|
18612
|
+
|
|
18613
|
+
Defined in: [lib/undici/request.ts:30](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L30)
|
|
18614
|
+
|
|
18615
|
+
设置 get 或 post 的数据
|
|
18616
|
+
|
|
18617
|
+
#### Parameters
|
|
18618
|
+
|
|
18619
|
+
##### data
|
|
18620
|
+
|
|
18621
|
+
`string` \| `Record`\<`string`, `any`\> \| `Buffer`\<`ArrayBufferLike`\> \| `Readable`
|
|
18622
|
+
|
|
18623
|
+
数据
|
|
18624
|
+
|
|
18625
|
+
#### Returns
|
|
18626
|
+
|
|
18627
|
+
`this`
|
|
18628
|
+
|
|
18629
|
+
***
|
|
18630
|
+
|
|
18631
|
+
### follow()
|
|
18632
|
+
|
|
18633
|
+
> **follow**(`follow?`): `this`
|
|
18634
|
+
|
|
18635
|
+
Defined in: [lib/undici/request.ts:87](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L87)
|
|
18636
|
+
|
|
18637
|
+
设置是否跟随请求方的 location,留空为跟随,不设置为不跟随
|
|
18638
|
+
|
|
18639
|
+
#### Parameters
|
|
18640
|
+
|
|
18641
|
+
##### follow?
|
|
18642
|
+
|
|
18643
|
+
`number` = `5`
|
|
18644
|
+
|
|
18645
|
+
#### Returns
|
|
18646
|
+
|
|
18647
|
+
`this`
|
|
18648
|
+
|
|
18649
|
+
***
|
|
18650
|
+
|
|
18651
|
+
### get()
|
|
18652
|
+
|
|
18653
|
+
> **get**(): `this`
|
|
18654
|
+
|
|
18655
|
+
Defined in: [lib/undici/request.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L47)
|
|
18656
|
+
|
|
18657
|
+
method get 方法别名
|
|
18658
|
+
|
|
18659
|
+
#### Returns
|
|
18660
|
+
|
|
18661
|
+
`this`
|
|
18662
|
+
|
|
18663
|
+
***
|
|
18664
|
+
|
|
18665
|
+
### headers()
|
|
18666
|
+
|
|
18667
|
+
> **headers**(`headers`): `this`
|
|
18668
|
+
|
|
18669
|
+
Defined in: [lib/undici/request.ts:123](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L123)
|
|
18670
|
+
|
|
18671
|
+
批量设置提交的 headers
|
|
18672
|
+
|
|
18673
|
+
#### Parameters
|
|
18674
|
+
|
|
18675
|
+
##### headers
|
|
18676
|
+
|
|
18677
|
+
[`THttpHeaders`](../../type-aliases/THttpHeaders.md)
|
|
18678
|
+
|
|
18679
|
+
#### Returns
|
|
18680
|
+
|
|
18681
|
+
`this`
|
|
18682
|
+
|
|
18683
|
+
***
|
|
18684
|
+
|
|
18685
|
+
### hosts()
|
|
18686
|
+
|
|
18687
|
+
> **hosts**(`hosts`): `this`
|
|
18688
|
+
|
|
18689
|
+
Defined in: [lib/undici/request.ts:96](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L96)
|
|
18690
|
+
|
|
18691
|
+
设置域名 -> ip的对应键值,就像电脑里的 hosts 一样
|
|
18692
|
+
|
|
18693
|
+
#### Parameters
|
|
18694
|
+
|
|
18695
|
+
##### hosts
|
|
18696
|
+
|
|
18697
|
+
`string` \| `Record`\<`string`, `string`\>
|
|
18698
|
+
|
|
18699
|
+
#### Returns
|
|
18700
|
+
|
|
18701
|
+
`this`
|
|
18702
|
+
|
|
18703
|
+
***
|
|
18704
|
+
|
|
18705
|
+
### json()
|
|
18706
|
+
|
|
18707
|
+
> **json**(): `this`
|
|
18708
|
+
|
|
18709
|
+
Defined in: [lib/undici/request.ts:70](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L70)
|
|
18710
|
+
|
|
18711
|
+
type json 方法别名
|
|
18712
|
+
|
|
18713
|
+
#### Returns
|
|
18714
|
+
|
|
18715
|
+
`this`
|
|
18716
|
+
|
|
18717
|
+
***
|
|
18718
|
+
|
|
18719
|
+
### local()
|
|
18720
|
+
|
|
18721
|
+
> **local**(`addr`): `this`
|
|
18722
|
+
|
|
18723
|
+
Defined in: [lib/undici/request.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L114)
|
|
18724
|
+
|
|
18725
|
+
设置使用的本地网卡 IP
|
|
18726
|
+
|
|
18727
|
+
#### Parameters
|
|
18728
|
+
|
|
18729
|
+
##### addr
|
|
18730
|
+
|
|
18731
|
+
`string`
|
|
18732
|
+
|
|
18733
|
+
#### Returns
|
|
18734
|
+
|
|
18735
|
+
`this`
|
|
18736
|
+
|
|
18737
|
+
***
|
|
18738
|
+
|
|
18739
|
+
### method()
|
|
18740
|
+
|
|
18741
|
+
> **method**(`method`): `this`
|
|
18742
|
+
|
|
18743
|
+
Defined in: [lib/undici/request.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L39)
|
|
18744
|
+
|
|
18745
|
+
设置 get 或 post 请求
|
|
18746
|
+
|
|
18747
|
+
#### Parameters
|
|
18748
|
+
|
|
18749
|
+
##### method
|
|
18750
|
+
|
|
18751
|
+
`"GET"` \| `"POST"`
|
|
18752
|
+
|
|
18753
|
+
#### Returns
|
|
18754
|
+
|
|
18755
|
+
`this`
|
|
18756
|
+
|
|
18757
|
+
***
|
|
18758
|
+
|
|
18759
|
+
### post()
|
|
18760
|
+
|
|
18761
|
+
> **post**(): `this`
|
|
18762
|
+
|
|
18763
|
+
Defined in: [lib/undici/request.ts:54](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L54)
|
|
18764
|
+
|
|
18765
|
+
method post 方法别名
|
|
18766
|
+
|
|
18767
|
+
#### Returns
|
|
18768
|
+
|
|
18769
|
+
`this`
|
|
18770
|
+
|
|
18771
|
+
***
|
|
18772
|
+
|
|
18773
|
+
### request()
|
|
18774
|
+
|
|
18775
|
+
> **request**(`cookie?`): `Promise`\<[`Response`](../../response/classes/Response.md)\>
|
|
18776
|
+
|
|
18777
|
+
Defined in: [lib/undici/request.ts:143](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L143)
|
|
18778
|
+
|
|
18779
|
+
发起请求
|
|
18780
|
+
|
|
18781
|
+
#### Parameters
|
|
18782
|
+
|
|
18783
|
+
##### cookie?
|
|
18784
|
+
|
|
18785
|
+
`Record`\<`string`, [`ICookie`](../../../cookie/interfaces/ICookie.md)\>
|
|
18786
|
+
|
|
18787
|
+
#### Returns
|
|
18788
|
+
|
|
18789
|
+
`Promise`\<[`Response`](../../response/classes/Response.md)\>
|
|
18790
|
+
|
|
18791
|
+
***
|
|
18792
|
+
|
|
18793
|
+
### save()
|
|
18794
|
+
|
|
18795
|
+
> **save**(`save`): `this`
|
|
18796
|
+
|
|
18797
|
+
Defined in: [lib/undici/request.ts:105](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L105)
|
|
18798
|
+
|
|
18799
|
+
设置后将直接保存到本地文件,不会返回,save 为本地实体路径
|
|
18800
|
+
|
|
18801
|
+
#### Parameters
|
|
18802
|
+
|
|
18803
|
+
##### save
|
|
18804
|
+
|
|
18805
|
+
`string`
|
|
18806
|
+
|
|
18807
|
+
#### Returns
|
|
18808
|
+
|
|
18809
|
+
`this`
|
|
18810
|
+
|
|
18811
|
+
***
|
|
18812
|
+
|
|
18813
|
+
### setHeader()
|
|
18814
|
+
|
|
18815
|
+
> **setHeader**(`name`, `val`): `this`
|
|
18816
|
+
|
|
18817
|
+
Defined in: [lib/undici/request.ts:133](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L133)
|
|
18818
|
+
|
|
18819
|
+
设置单条 header
|
|
18820
|
+
|
|
18821
|
+
#### Parameters
|
|
18822
|
+
|
|
18823
|
+
##### name
|
|
18824
|
+
|
|
18825
|
+
`string`
|
|
18826
|
+
|
|
18827
|
+
##### val
|
|
18828
|
+
|
|
18829
|
+
`string`
|
|
18830
|
+
|
|
18831
|
+
#### Returns
|
|
18832
|
+
|
|
18833
|
+
`this`
|
|
18834
|
+
|
|
18835
|
+
***
|
|
18836
|
+
|
|
18837
|
+
### timeout()
|
|
18838
|
+
|
|
18839
|
+
> **timeout**(`timeout`): `this`
|
|
18840
|
+
|
|
18841
|
+
Defined in: [lib/undici/request.ts:78](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L78)
|
|
18842
|
+
|
|
18843
|
+
设置请求有效期
|
|
18844
|
+
|
|
18845
|
+
#### Parameters
|
|
18846
|
+
|
|
18847
|
+
##### timeout
|
|
18848
|
+
|
|
18849
|
+
`number`
|
|
18850
|
+
|
|
18851
|
+
秒
|
|
18852
|
+
|
|
18853
|
+
#### Returns
|
|
18854
|
+
|
|
18855
|
+
`this`
|
|
18856
|
+
|
|
18857
|
+
***
|
|
18858
|
+
|
|
18859
|
+
### type()
|
|
18860
|
+
|
|
18861
|
+
> **type**(`type`): `this`
|
|
18862
|
+
|
|
18863
|
+
Defined in: [lib/undici/request.ts:62](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L62)
|
|
18864
|
+
|
|
18865
|
+
设置提交模式,json 还是普通 form
|
|
18866
|
+
|
|
18867
|
+
#### Parameters
|
|
18868
|
+
|
|
18869
|
+
##### type
|
|
18870
|
+
|
|
18871
|
+
`"form"` \| `"json"`
|
|
18872
|
+
|
|
18873
|
+
#### Returns
|
|
18874
|
+
|
|
18875
|
+
`this`
|
|
18876
|
+
|
|
18877
|
+
lib/undici/request/index.md
|
|
18878
|
+
---
|
|
18879
|
+
|
|
18880
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
18881
|
+
|
|
18882
|
+
***
|
|
18883
|
+
|
|
18884
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / lib/undici/request
|
|
18885
|
+
|
|
18886
|
+
# lib/undici/request
|
|
18887
|
+
|
|
18888
|
+
## Classes
|
|
18889
|
+
|
|
18890
|
+
- [Request](classes/Request.md)
|
|
18891
|
+
|
|
18892
|
+
lib/undici/response/classes/Response.md
|
|
18893
|
+
---
|
|
18894
|
+
|
|
18895
|
+
[**Documents for @maiyunnet/kebab**](../../../../index.md)
|
|
18896
|
+
|
|
18897
|
+
***
|
|
18898
|
+
|
|
18899
|
+
[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/undici/response](../index.md) / Response
|
|
18900
|
+
|
|
18901
|
+
# Class: Response
|
|
18902
|
+
|
|
18903
|
+
Defined in: [lib/undici/response.ts:12](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L12)
|
|
18904
|
+
|
|
18905
|
+
## Constructors
|
|
18906
|
+
|
|
18907
|
+
### Constructor
|
|
18908
|
+
|
|
18909
|
+
> **new Response**(`req`): `Response`
|
|
18910
|
+
|
|
18911
|
+
Defined in: [lib/undici/response.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L25)
|
|
18912
|
+
|
|
18913
|
+
#### Parameters
|
|
18914
|
+
|
|
18915
|
+
##### req
|
|
18916
|
+
|
|
18917
|
+
`ResponseData`\<`null`\> \| `null`
|
|
18918
|
+
|
|
18919
|
+
#### Returns
|
|
18920
|
+
|
|
18921
|
+
`Response`
|
|
18922
|
+
|
|
18923
|
+
## Properties
|
|
18924
|
+
|
|
18925
|
+
### error
|
|
18926
|
+
|
|
18927
|
+
> **error**: `Error` \| `null` = `null`
|
|
18928
|
+
|
|
18929
|
+
Defined in: [lib/undici/response.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L20)
|
|
18930
|
+
|
|
18931
|
+
***
|
|
18932
|
+
|
|
18933
|
+
### headers
|
|
18934
|
+
|
|
18935
|
+
> **headers**: [`THttpHeaders`](../../type-aliases/THttpHeaders.md) \| `null` = `null`
|
|
18936
|
+
|
|
18937
|
+
Defined in: [lib/undici/response.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L18)
|
|
18938
|
+
|
|
18939
|
+
返回的 headers
|
|
18940
|
+
|
|
18941
|
+
## Methods
|
|
18942
|
+
|
|
18943
|
+
### getContent()
|
|
18944
|
+
|
|
18945
|
+
> **getContent**(): `Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
|
|
18946
|
+
|
|
18947
|
+
Defined in: [lib/undici/response.ts:32](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L32)
|
|
18948
|
+
|
|
18949
|
+
读取所有内容到内存
|
|
18950
|
+
|
|
18951
|
+
#### Returns
|
|
18952
|
+
|
|
18953
|
+
`Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
|
|
18954
|
+
|
|
18955
|
+
***
|
|
18956
|
+
|
|
18957
|
+
### getJson()
|
|
18958
|
+
|
|
18959
|
+
> **getJson**(): `Promise`\<`any`\>
|
|
18960
|
+
|
|
18961
|
+
Defined in: [lib/undici/response.ts:63](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L63)
|
|
18962
|
+
|
|
18963
|
+
读取所有内容为 JSON
|
|
18964
|
+
|
|
18965
|
+
#### Returns
|
|
18966
|
+
|
|
18967
|
+
`Promise`\<`any`\>
|
|
18968
|
+
|
|
18969
|
+
***
|
|
18970
|
+
|
|
18971
|
+
### getRawStream()
|
|
18972
|
+
|
|
18973
|
+
> **getRawStream**(): `BodyReadable` & `BodyMixin` \| `null`
|
|
18974
|
+
|
|
18975
|
+
Defined in: [lib/undici/response.ts:124](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L124)
|
|
18976
|
+
|
|
18977
|
+
获取原生响应读取流对象
|
|
18978
|
+
|
|
18979
|
+
#### Returns
|
|
18980
|
+
|
|
18981
|
+
`BodyReadable` & `BodyMixin` \| `null`
|
|
18982
|
+
|
|
18983
|
+
***
|
|
18984
|
+
|
|
18985
|
+
### getStream()
|
|
18986
|
+
|
|
18987
|
+
> **getStream**(): `BrotliDecompress` \| `Gunzip` \| `Inflate` \| `BodyReadable` & `BodyMixin` \| `null`
|
|
18988
|
+
|
|
18989
|
+
Defined in: [lib/undici/response.ts:88](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L88)
|
|
18990
|
+
|
|
18991
|
+
获取响应读取流对象
|
|
18992
|
+
|
|
18993
|
+
#### Returns
|
|
18994
|
+
|
|
18995
|
+
`BrotliDecompress` \| `Gunzip` \| `Inflate` \| `BodyReadable` & `BodyMixin` \| `null`
|
|
18996
|
+
|
|
18997
|
+
***
|
|
18998
|
+
|
|
18999
|
+
### getText()
|
|
19000
|
+
|
|
19001
|
+
> **getText**(): `Promise`\<`string` \| `null`\>
|
|
19002
|
+
|
|
19003
|
+
Defined in: [lib/undici/response.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L49)
|
|
19004
|
+
|
|
19005
|
+
读取所有内容为文本
|
|
19006
|
+
|
|
19007
|
+
#### Returns
|
|
19008
|
+
|
|
19009
|
+
`Promise`\<`string` \| `null`\>
|
|
19010
|
+
|
|
19011
|
+
***
|
|
19012
|
+
|
|
19013
|
+
### setContent()
|
|
19014
|
+
|
|
19015
|
+
> **setContent**(`v`): `void`
|
|
19016
|
+
|
|
19017
|
+
Defined in: [lib/undici/response.ts:80](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L80)
|
|
19018
|
+
|
|
19019
|
+
用户自定义的 content 内容
|
|
19020
|
+
|
|
19021
|
+
#### Parameters
|
|
19022
|
+
|
|
19023
|
+
##### v
|
|
19024
|
+
|
|
19025
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
19026
|
+
|
|
19027
|
+
内容值
|
|
19028
|
+
|
|
19029
|
+
#### Returns
|
|
19030
|
+
|
|
19031
|
+
`void`
|
|
19032
|
+
|
|
19033
|
+
lib/undici/response/index.md
|
|
19034
|
+
---
|
|
19035
|
+
|
|
19036
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
19037
|
+
|
|
19038
|
+
***
|
|
19039
|
+
|
|
19040
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / lib/undici/response
|
|
19041
|
+
|
|
19042
|
+
# lib/undici/response
|
|
19043
|
+
|
|
19044
|
+
## Classes
|
|
19045
|
+
|
|
19046
|
+
- [Response](classes/Response.md)
|
|
19047
|
+
|
|
19048
|
+
lib/undici/type-aliases/THttpHeaders.md
|
|
19049
|
+
---
|
|
19050
|
+
|
|
19051
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
19052
|
+
|
|
19053
|
+
***
|
|
19054
|
+
|
|
19055
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/undici](../index.md) / THttpHeaders
|
|
19056
|
+
|
|
19057
|
+
# Type Alias: THttpHeaders
|
|
19058
|
+
|
|
19059
|
+
> **THttpHeaders** = `http.IncomingHttpHeaders` & `object`
|
|
19060
|
+
|
|
19061
|
+
Defined in: [lib/undici.ts:742](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L742)
|
|
19062
|
+
|
|
19063
|
+
http headers
|
|
19064
|
+
|
|
19065
|
+
## Type Declaration
|
|
19066
|
+
|
|
19067
|
+
### http-code?
|
|
19068
|
+
|
|
19069
|
+
> `optional` **http-code?**: `number`
|
|
19070
|
+
|
|
19071
|
+
### http-url?
|
|
19072
|
+
|
|
19073
|
+
> `optional` **http-url?**: `string`
|
|
19074
|
+
|
|
19075
|
+
lib/vector/classes/Vector.md
|
|
19076
|
+
---
|
|
19077
|
+
|
|
19078
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
19079
|
+
|
|
19080
|
+
***
|
|
19081
|
+
|
|
19082
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/vector](../index.md) / Vector
|
|
19083
|
+
|
|
19084
|
+
# Class: Vector
|
|
19085
|
+
|
|
19086
|
+
Defined in: [lib/vector.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L31)
|
|
19087
|
+
|
|
19088
|
+
## Constructors
|
|
19089
|
+
|
|
19090
|
+
### Constructor
|
|
19091
|
+
|
|
19092
|
+
> **new Vector**(`etc`): `Vector`
|
|
19093
|
+
|
|
19094
|
+
Defined in: [lib/vector.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L36)
|
|
19095
|
+
|
|
19096
|
+
#### Parameters
|
|
19097
|
+
|
|
19098
|
+
##### etc
|
|
19099
|
+
|
|
19100
|
+
[`IConfigVector`](../../../index/interfaces/IConfigVector.md)
|
|
19101
|
+
|
|
19102
|
+
#### Returns
|
|
19103
|
+
|
|
19104
|
+
`Vector`
|
|
19105
|
+
|
|
19106
|
+
## Methods
|
|
19107
|
+
|
|
19108
|
+
### delete()
|
|
19109
|
+
|
|
19110
|
+
> **delete**(`data`): `Promise`\<`false` \| `MutationResult`\>
|
|
19111
|
+
|
|
19112
|
+
Defined in: [lib/vector.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L104)
|
|
19113
|
+
|
|
19114
|
+
删除数据
|
|
19115
|
+
|
|
19116
|
+
#### Parameters
|
|
19117
|
+
|
|
19118
|
+
##### data
|
|
19119
|
+
|
|
19120
|
+
###### collection
|
|
19121
|
+
|
|
19122
|
+
`string`
|
|
17323
19123
|
|
|
17324
19124
|
表名
|
|
17325
19125
|
|
|
@@ -17545,7 +19345,7 @@ lib/ws/classes/Socket.md
|
|
|
17545
19345
|
|
|
17546
19346
|
# Class: Socket
|
|
17547
19347
|
|
|
17548
|
-
Defined in: [lib/ws.ts:
|
|
19348
|
+
Defined in: [lib/ws.ts:96](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L96)
|
|
17549
19349
|
|
|
17550
19350
|
## Constructors
|
|
17551
19351
|
|
|
@@ -17553,7 +19353,7 @@ Defined in: [lib/ws.ts:95](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
17553
19353
|
|
|
17554
19354
|
> **new Socket**(`request?`, `socket?`, `head?`, `options?`): `Socket`
|
|
17555
19355
|
|
|
17556
|
-
Defined in: [lib/ws.ts:
|
|
19356
|
+
Defined in: [lib/ws.ts:101](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L101)
|
|
17557
19357
|
|
|
17558
19358
|
#### Parameters
|
|
17559
19359
|
|
|
@@ -17653,7 +19453,7 @@ Defined in: [lib/ws.ts:361](https://github.com/maiyunnet/kebab/blob/master/lib/w
|
|
|
17653
19453
|
|
|
17654
19454
|
> **connect**(`u`, `opt?`): `Promise`\<`Socket` \| `null`\>
|
|
17655
19455
|
|
|
17656
|
-
Defined in: [lib/ws.ts:
|
|
19456
|
+
Defined in: [lib/ws.ts:124](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L124)
|
|
17657
19457
|
|
|
17658
19458
|
以客户端形式发起链接
|
|
17659
19459
|
|
|
@@ -17900,7 +19700,7 @@ lib/ws/enumerations/EFrameReceiveMode.md
|
|
|
17900
19700
|
|
|
17901
19701
|
# Enumeration: EFrameReceiveMode
|
|
17902
19702
|
|
|
17903
|
-
Defined in: [lib/ws.ts:
|
|
19703
|
+
Defined in: [lib/ws.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L18)
|
|
17904
19704
|
|
|
17905
19705
|
一般用 SIMPLE
|
|
17906
19706
|
|
|
@@ -17910,7 +19710,7 @@ Defined in: [lib/ws.ts:17](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
17910
19710
|
|
|
17911
19711
|
> **LITE**: `1`
|
|
17912
19712
|
|
|
17913
|
-
Defined in: [lib/ws.ts:
|
|
19713
|
+
Defined in: [lib/ws.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L20)
|
|
17914
19714
|
|
|
17915
19715
|
***
|
|
17916
19716
|
|
|
@@ -17918,7 +19718,7 @@ Defined in: [lib/ws.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
17918
19718
|
|
|
17919
19719
|
> **SIMPLE**: `2`
|
|
17920
19720
|
|
|
17921
|
-
Defined in: [lib/ws.ts:
|
|
19721
|
+
Defined in: [lib/ws.ts:21](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L21)
|
|
17922
19722
|
|
|
17923
19723
|
***
|
|
17924
19724
|
|
|
@@ -17926,7 +19726,7 @@ Defined in: [lib/ws.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
17926
19726
|
|
|
17927
19727
|
> **STANDARD**: `0`
|
|
17928
19728
|
|
|
17929
|
-
Defined in: [lib/ws.ts:
|
|
19729
|
+
Defined in: [lib/ws.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L19)
|
|
17930
19730
|
|
|
17931
19731
|
lib/ws/enumerations/EOpcode.md
|
|
17932
19732
|
---
|
|
@@ -17939,7 +19739,7 @@ lib/ws/enumerations/EOpcode.md
|
|
|
17939
19739
|
|
|
17940
19740
|
# Enumeration: EOpcode
|
|
17941
19741
|
|
|
17942
|
-
Defined in: [lib/ws.ts:
|
|
19742
|
+
Defined in: [lib/ws.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L25)
|
|
17943
19743
|
|
|
17944
19744
|
OPCODE
|
|
17945
19745
|
|
|
@@ -17949,7 +19749,7 @@ OPCODE
|
|
|
17949
19749
|
|
|
17950
19750
|
> **BINARY**: `2`
|
|
17951
19751
|
|
|
17952
|
-
Defined in: [lib/ws.ts:
|
|
19752
|
+
Defined in: [lib/ws.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L28)
|
|
17953
19753
|
|
|
17954
19754
|
***
|
|
17955
19755
|
|
|
@@ -17957,7 +19757,7 @@ Defined in: [lib/ws.ts:27](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
17957
19757
|
|
|
17958
19758
|
> **CLOSE**: `8`
|
|
17959
19759
|
|
|
17960
|
-
Defined in: [lib/ws.ts:
|
|
19760
|
+
Defined in: [lib/ws.ts:29](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L29)
|
|
17961
19761
|
|
|
17962
19762
|
***
|
|
17963
19763
|
|
|
@@ -17965,7 +19765,7 @@ Defined in: [lib/ws.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
17965
19765
|
|
|
17966
19766
|
> **CONTINUATION**: `0`
|
|
17967
19767
|
|
|
17968
|
-
Defined in: [lib/ws.ts:
|
|
19768
|
+
Defined in: [lib/ws.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L26)
|
|
17969
19769
|
|
|
17970
19770
|
***
|
|
17971
19771
|
|
|
@@ -17973,7 +19773,7 @@ Defined in: [lib/ws.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
17973
19773
|
|
|
17974
19774
|
> **PING**: `9`
|
|
17975
19775
|
|
|
17976
|
-
Defined in: [lib/ws.ts:
|
|
19776
|
+
Defined in: [lib/ws.ts:30](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L30)
|
|
17977
19777
|
|
|
17978
19778
|
***
|
|
17979
19779
|
|
|
@@ -17981,7 +19781,7 @@ Defined in: [lib/ws.ts:29](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
17981
19781
|
|
|
17982
19782
|
> **PONG**: `10`
|
|
17983
19783
|
|
|
17984
|
-
Defined in: [lib/ws.ts:
|
|
19784
|
+
Defined in: [lib/ws.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L31)
|
|
17985
19785
|
|
|
17986
19786
|
***
|
|
17987
19787
|
|
|
@@ -17989,7 +19789,7 @@ Defined in: [lib/ws.ts:30](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
17989
19789
|
|
|
17990
19790
|
> **TEXT**: `1`
|
|
17991
19791
|
|
|
17992
|
-
Defined in: [lib/ws.ts:
|
|
19792
|
+
Defined in: [lib/ws.ts:27](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L27)
|
|
17993
19793
|
|
|
17994
19794
|
lib/ws/functions/connect.md
|
|
17995
19795
|
---
|
|
@@ -18244,7 +20044,7 @@ lib/ws/interfaces/IConnectOptions.md
|
|
|
18244
20044
|
|
|
18245
20045
|
# Interface: IConnectOptions
|
|
18246
20046
|
|
|
18247
|
-
Defined in: [lib/ws.ts:
|
|
20047
|
+
Defined in: [lib/ws.ts:35](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L35)
|
|
18248
20048
|
|
|
18249
20049
|
请求的传入参数选项
|
|
18250
20050
|
|
|
@@ -18252,9 +20052,9 @@ Defined in: [lib/ws.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18252
20052
|
|
|
18253
20053
|
### cookie?
|
|
18254
20054
|
|
|
18255
|
-
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../
|
|
20055
|
+
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../cookie/interfaces/ICookie.md)\>
|
|
18256
20056
|
|
|
18257
|
-
Defined in: [lib/ws.ts:
|
|
20057
|
+
Defined in: [lib/ws.ts:43](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L43)
|
|
18258
20058
|
|
|
18259
20059
|
cookie 托管对象
|
|
18260
20060
|
|
|
@@ -18262,9 +20062,9 @@ cookie 托管对象
|
|
|
18262
20062
|
|
|
18263
20063
|
### headers?
|
|
18264
20064
|
|
|
18265
|
-
> `optional` **headers?**: [`THttpHeaders`](../../
|
|
20065
|
+
> `optional` **headers?**: [`THttpHeaders`](../../undici/type-aliases/THttpHeaders.md)
|
|
18266
20066
|
|
|
18267
|
-
Defined in: [lib/ws.ts:
|
|
20067
|
+
Defined in: [lib/ws.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L41)
|
|
18268
20068
|
|
|
18269
20069
|
***
|
|
18270
20070
|
|
|
@@ -18272,7 +20072,7 @@ Defined in: [lib/ws.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18272
20072
|
|
|
18273
20073
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
18274
20074
|
|
|
18275
|
-
Defined in: [lib/ws.ts:
|
|
20075
|
+
Defined in: [lib/ws.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L39)
|
|
18276
20076
|
|
|
18277
20077
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
18278
20078
|
|
|
@@ -18282,7 +20082,7 @@ Defined in: [lib/ws.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18282
20082
|
|
|
18283
20083
|
> `optional` **local?**: `string`
|
|
18284
20084
|
|
|
18285
|
-
Defined in: [lib/ws.ts:
|
|
20085
|
+
Defined in: [lib/ws.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L40)
|
|
18286
20086
|
|
|
18287
20087
|
***
|
|
18288
20088
|
|
|
@@ -18290,7 +20090,7 @@ Defined in: [lib/ws.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18290
20090
|
|
|
18291
20091
|
> `optional` **masking?**: `boolean`
|
|
18292
20092
|
|
|
18293
|
-
Defined in: [lib/ws.ts:
|
|
20093
|
+
Defined in: [lib/ws.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L47)
|
|
18294
20094
|
|
|
18295
20095
|
加密模式,默认 true
|
|
18296
20096
|
|
|
@@ -18300,7 +20100,7 @@ Defined in: [lib/ws.ts:46](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18300
20100
|
|
|
18301
20101
|
> `optional` **mode?**: [`EFrameReceiveMode`](../enumerations/EFrameReceiveMode.md)
|
|
18302
20102
|
|
|
18303
|
-
Defined in: [lib/ws.ts:
|
|
20103
|
+
Defined in: [lib/ws.ts:45](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L45)
|
|
18304
20104
|
|
|
18305
20105
|
小帧模式,默认 false
|
|
18306
20106
|
|
|
@@ -18310,7 +20110,7 @@ Defined in: [lib/ws.ts:44](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18310
20110
|
|
|
18311
20111
|
> `optional` **mproxy?**: `object`
|
|
18312
20112
|
|
|
18313
|
-
Defined in: [lib/ws.ts:
|
|
20113
|
+
Defined in: [lib/ws.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L49)
|
|
18314
20114
|
|
|
18315
20115
|
正向 mproxy 代理,url 如 wss://xxx/abc
|
|
18316
20116
|
|
|
@@ -18328,7 +20128,7 @@ Defined in: [lib/ws.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18328
20128
|
|
|
18329
20129
|
> `optional` **timeout?**: `number`
|
|
18330
20130
|
|
|
18331
|
-
Defined in: [lib/ws.ts:
|
|
20131
|
+
Defined in: [lib/ws.ts:37](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L37)
|
|
18332
20132
|
|
|
18333
20133
|
秒数
|
|
18334
20134
|
|
|
@@ -18343,7 +20143,7 @@ lib/ws/interfaces/IMproxyOptions.md
|
|
|
18343
20143
|
|
|
18344
20144
|
# Interface: IMproxyOptions
|
|
18345
20145
|
|
|
18346
|
-
Defined in: [lib/ws.ts:
|
|
20146
|
+
Defined in: [lib/ws.ts:56](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L56)
|
|
18347
20147
|
|
|
18348
20148
|
正向代理请求的传入参数选项
|
|
18349
20149
|
|
|
@@ -18353,7 +20153,7 @@ Defined in: [lib/ws.ts:55](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18353
20153
|
|
|
18354
20154
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
18355
20155
|
|
|
18356
|
-
Defined in: [lib/ws.ts:
|
|
20156
|
+
Defined in: [lib/ws.ts:64](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L64)
|
|
18357
20157
|
|
|
18358
20158
|
过滤 header,返回 true 则留下
|
|
18359
20159
|
|
|
@@ -18371,9 +20171,9 @@ Defined in: [lib/ws.ts:63](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18371
20171
|
|
|
18372
20172
|
### headers?
|
|
18373
20173
|
|
|
18374
|
-
> `optional` **headers?**: [`THttpHeaders`](../../
|
|
20174
|
+
> `optional` **headers?**: [`THttpHeaders`](../../undici/type-aliases/THttpHeaders.md)
|
|
18375
20175
|
|
|
18376
|
-
Defined in: [lib/ws.ts:
|
|
20176
|
+
Defined in: [lib/ws.ts:62](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L62)
|
|
18377
20177
|
|
|
18378
20178
|
***
|
|
18379
20179
|
|
|
@@ -18381,7 +20181,7 @@ Defined in: [lib/ws.ts:61](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18381
20181
|
|
|
18382
20182
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
18383
20183
|
|
|
18384
|
-
Defined in: [lib/ws.ts:
|
|
20184
|
+
Defined in: [lib/ws.ts:60](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L60)
|
|
18385
20185
|
|
|
18386
20186
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
18387
20187
|
|
|
@@ -18391,7 +20191,7 @@ Defined in: [lib/ws.ts:59](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18391
20191
|
|
|
18392
20192
|
> `optional` **local?**: `string`
|
|
18393
20193
|
|
|
18394
|
-
Defined in: [lib/ws.ts:
|
|
20194
|
+
Defined in: [lib/ws.ts:61](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L61)
|
|
18395
20195
|
|
|
18396
20196
|
***
|
|
18397
20197
|
|
|
@@ -18399,7 +20199,7 @@ Defined in: [lib/ws.ts:60](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18399
20199
|
|
|
18400
20200
|
> `optional` **masking?**: `boolean`
|
|
18401
20201
|
|
|
18402
|
-
Defined in: [lib/ws.ts:
|
|
20202
|
+
Defined in: [lib/ws.ts:68](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L68)
|
|
18403
20203
|
|
|
18404
20204
|
加密模式,默认 true
|
|
18405
20205
|
|
|
@@ -18409,7 +20209,7 @@ Defined in: [lib/ws.ts:67](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18409
20209
|
|
|
18410
20210
|
> `optional` **mode?**: [`EFrameReceiveMode`](../enumerations/EFrameReceiveMode.md)
|
|
18411
20211
|
|
|
18412
|
-
Defined in: [lib/ws.ts:
|
|
20212
|
+
Defined in: [lib/ws.ts:66](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L66)
|
|
18413
20213
|
|
|
18414
20214
|
小帧模式,默认 false
|
|
18415
20215
|
|
|
@@ -18419,7 +20219,7 @@ Defined in: [lib/ws.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18419
20219
|
|
|
18420
20220
|
> `optional` **timeout?**: `number`
|
|
18421
20221
|
|
|
18422
|
-
Defined in: [lib/ws.ts:
|
|
20222
|
+
Defined in: [lib/ws.ts:58](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L58)
|
|
18423
20223
|
|
|
18424
20224
|
秒数
|
|
18425
20225
|
|
|
@@ -18434,7 +20234,7 @@ lib/ws/interfaces/IRproxyOptions.md
|
|
|
18434
20234
|
|
|
18435
20235
|
# Interface: IRproxyOptions
|
|
18436
20236
|
|
|
18437
|
-
Defined in: [lib/ws.ts:
|
|
20237
|
+
Defined in: [lib/ws.ts:72](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L72)
|
|
18438
20238
|
|
|
18439
20239
|
反向代理请求的传入参数选项
|
|
18440
20240
|
|
|
@@ -18444,7 +20244,7 @@ Defined in: [lib/ws.ts:71](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18444
20244
|
|
|
18445
20245
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
18446
20246
|
|
|
18447
|
-
Defined in: [lib/ws.ts:
|
|
20247
|
+
Defined in: [lib/ws.ts:80](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L80)
|
|
18448
20248
|
|
|
18449
20249
|
过滤 header,返回 true 则留下
|
|
18450
20250
|
|
|
@@ -18462,9 +20262,9 @@ Defined in: [lib/ws.ts:79](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18462
20262
|
|
|
18463
20263
|
### headers?
|
|
18464
20264
|
|
|
18465
|
-
> `optional` **headers?**: [`THttpHeaders`](../../
|
|
20265
|
+
> `optional` **headers?**: [`THttpHeaders`](../../undici/type-aliases/THttpHeaders.md)
|
|
18466
20266
|
|
|
18467
|
-
Defined in: [lib/ws.ts:
|
|
20267
|
+
Defined in: [lib/ws.ts:78](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L78)
|
|
18468
20268
|
|
|
18469
20269
|
***
|
|
18470
20270
|
|
|
@@ -18472,7 +20272,7 @@ Defined in: [lib/ws.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18472
20272
|
|
|
18473
20273
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
18474
20274
|
|
|
18475
|
-
Defined in: [lib/ws.ts:
|
|
20275
|
+
Defined in: [lib/ws.ts:76](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L76)
|
|
18476
20276
|
|
|
18477
20277
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
18478
20278
|
|
|
@@ -18482,7 +20282,7 @@ Defined in: [lib/ws.ts:75](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18482
20282
|
|
|
18483
20283
|
> `optional` **local?**: `string`
|
|
18484
20284
|
|
|
18485
|
-
Defined in: [lib/ws.ts:
|
|
20285
|
+
Defined in: [lib/ws.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L77)
|
|
18486
20286
|
|
|
18487
20287
|
***
|
|
18488
20288
|
|
|
@@ -18490,7 +20290,7 @@ Defined in: [lib/ws.ts:76](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18490
20290
|
|
|
18491
20291
|
> `optional` **masking?**: `boolean`
|
|
18492
20292
|
|
|
18493
|
-
Defined in: [lib/ws.ts:
|
|
20293
|
+
Defined in: [lib/ws.ts:84](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L84)
|
|
18494
20294
|
|
|
18495
20295
|
加密模式,默认 true
|
|
18496
20296
|
|
|
@@ -18500,7 +20300,7 @@ Defined in: [lib/ws.ts:83](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18500
20300
|
|
|
18501
20301
|
> `optional` **mode?**: [`EFrameReceiveMode`](../enumerations/EFrameReceiveMode.md)
|
|
18502
20302
|
|
|
18503
|
-
Defined in: [lib/ws.ts:
|
|
20303
|
+
Defined in: [lib/ws.ts:82](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L82)
|
|
18504
20304
|
|
|
18505
20305
|
小帧模式,默认 false
|
|
18506
20306
|
|
|
@@ -18510,7 +20310,7 @@ Defined in: [lib/ws.ts:81](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18510
20310
|
|
|
18511
20311
|
> `optional` **mproxy?**: `object`
|
|
18512
20312
|
|
|
18513
|
-
Defined in: [lib/ws.ts:
|
|
20313
|
+
Defined in: [lib/ws.ts:86](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L86)
|
|
18514
20314
|
|
|
18515
20315
|
正向 mproxy 代理,url 如 wss://xxx/abc
|
|
18516
20316
|
|
|
@@ -18528,7 +20328,7 @@ Defined in: [lib/ws.ts:85](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18528
20328
|
|
|
18529
20329
|
> `optional` **timeout?**: `number`
|
|
18530
20330
|
|
|
18531
|
-
Defined in: [lib/ws.ts:
|
|
20331
|
+
Defined in: [lib/ws.ts:74](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L74)
|
|
18532
20332
|
|
|
18533
20333
|
秒数
|
|
18534
20334
|
|
|
@@ -23913,7 +25713,7 @@ sys/route/functions/clearKebabConfigs.md
|
|
|
23913
25713
|
|
|
23914
25714
|
> **clearKebabConfigs**(): `void`
|
|
23915
25715
|
|
|
23916
|
-
Defined in: [sys/route.ts:
|
|
25716
|
+
Defined in: [sys/route.ts:31](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L31)
|
|
23917
25717
|
|
|
23918
25718
|
清除已经加载的虚拟主机配置文件
|
|
23919
25719
|
|
|
@@ -23934,7 +25734,7 @@ sys/route/functions/getFormData.md
|
|
|
23934
25734
|
|
|
23935
25735
|
> **getFormData**(`req`, `events?`, `limits?`): `Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>
|
|
23936
25736
|
|
|
23937
|
-
Defined in: [sys/route.ts:
|
|
25737
|
+
Defined in: [sys/route.ts:967](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L967)
|
|
23938
25738
|
|
|
23939
25739
|
获取 formdata 的 post
|
|
23940
25740
|
|
|
@@ -24001,7 +25801,7 @@ sys/route/functions/getPost.md
|
|
|
24001
25801
|
|
|
24002
25802
|
> **getPost**(`req`): `Promise`\<\{ `input`: `string`; `post`: `Record`\<`string`, `any`\>; `raw`: `Record`\<`string`, `any`\>; \}\>
|
|
24003
25803
|
|
|
24004
|
-
Defined in: [sys/route.ts:
|
|
25804
|
+
Defined in: [sys/route.ts:881](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L881)
|
|
24005
25805
|
|
|
24006
25806
|
获取 post 对象(通常已自动获取),如果是文件上传(formdata)的情况则不获取
|
|
24007
25807
|
|
|
@@ -24030,7 +25830,7 @@ sys/route/functions/run.md
|
|
|
24030
25830
|
|
|
24031
25831
|
> **run**(`data`): `Promise`\<`boolean`\>
|
|
24032
25832
|
|
|
24033
|
-
Defined in: [sys/route.ts:
|
|
25833
|
+
Defined in: [sys/route.ts:77](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L77)
|
|
24034
25834
|
|
|
24035
25835
|
若为动态路径则执行此函数,此函数不进行判断 kebab.json 是否存在
|
|
24036
25836
|
|
|
@@ -24117,7 +25917,7 @@ sys/route/functions/unlinkUploadFiles.md
|
|
|
24117
25917
|
|
|
24118
25918
|
> **unlinkUploadFiles**(`cctr`): `Promise`\<`void`\>
|
|
24119
25919
|
|
|
24120
|
-
Defined in: [sys/route.ts:
|
|
25920
|
+
Defined in: [sys/route.ts:840](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L840)
|
|
24121
25921
|
|
|
24122
25922
|
删除本次请求所有已上传的临时文件
|
|
24123
25923
|
|
|
@@ -24146,7 +25946,7 @@ sys/route/functions/waitCtr.md
|
|
|
24146
25946
|
|
|
24147
25947
|
> **waitCtr**(`cctr`): `Promise`\<`void`\>
|
|
24148
25948
|
|
|
24149
|
-
Defined in: [sys/route.ts:
|
|
25949
|
+
Defined in: [sys/route.ts:860](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L860)
|
|
24150
25950
|
|
|
24151
25951
|
等待异步任务结束,并删除临时文件,如果结束后还有事务没关闭,则会在本函数中打印控制台并且写入 log 文件
|
|
24152
25952
|
此时其实已经给客户端返回了,此处等待不消耗客户端的等待时间
|