@maiyunnet/kebab 7.5.0 → 7.6.1

package/doc/sc/api/lib/ws/classes/Socket.md

@@ -0,0 +1,331 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ws](../index.md) / Socket
+
+# Class: Socket
+
+Defined in: [lib/ws.ts:95](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L95)
+
+## Constructors
+
+### Constructor
+
+> **new Socket**(`request?`, `socket?`, `head?`, `options?`): `Socket`
+
+Defined in: [lib/ws.ts:100](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L100)
+
+#### Parameters
+
+##### request?
+
+`IncomingMessage`
+
+##### socket?
+
+`Socket`
+
+##### head?
+
+`Buffer`\<`ArrayBufferLike`\>
+
+##### options?
+
+###### headers?
+
+`OutgoingHttpHeaders`
+
+###### timeout?
+
+`number`
+
+#### Returns
+
+`Socket`
+
+## Accessors
+
+### ended
+
+#### Get Signature
+
+> **get** **ended**(): `boolean`
+
+Defined in: [lib/ws.ts:338](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L338)
+
+当前是否已经结束读取，并且无法继续读取
+
+##### Returns
+
+`boolean`
+
+***
+
+### finished
+
+#### Get Signature
+
+> **get** **finished**(): `boolean`
+
+Defined in: [lib/ws.ts:343](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L343)
+
+当前是否已经结束写入，并且无法继续写入
+
+##### Returns
+
+`boolean`
+
+***
+
+### isServer
+
+#### Get Signature
+
+> **get** **isServer**(): `boolean`
+
+Defined in: [lib/ws.ts:350](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L350)
+
+当前连接是不是服务器连接
+
+##### Returns
+
+`boolean`
+
+***
+
+### writable
+
+#### Get Signature
+
+> **get** **writable**(): `boolean`
+
+Defined in: [lib/ws.ts:333](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L333)
+
+当前是否是可写状态
+
+##### Returns
+
+`boolean`
+
+## Methods
+
+### connect()
+
+> **connect**(`u`, `opt`): `Promise`\<`Socket` \| `null`\>
+
+Defined in: [lib/ws.ts:123](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L123)
+
+以客户端形式发起链接
+
+#### Parameters
+
+##### u
+
+`string`
+
+以 ws, wss 开头的地址
+
+##### opt
+
+[`IConnectOptions`](../interfaces/IConnectOptions.md) = `{}`
+
+参数
+
+#### Returns
+
+`Promise`\<`Socket` \| `null`\>
+
+***
+
+### destroy()
+
+> **destroy**(): `void`
+
+Defined in: [lib/ws.ts:304](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L304)
+
+#### Returns
+
+`void`
+
+***
+
+### end()
+
+> **end**(): `void`
+
+Defined in: [lib/ws.ts:300](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L300)
+
+#### Returns
+
+`void`
+
+***
+
+### on()
+
+#### Call Signature
+
+> **on**(`event`, `cb`): `this`
+
+Defined in: [lib/ws.ts:260](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L260)
+
+绑定监听
+
+##### Parameters
+
+###### event
+
+`"message"`
+
+###### cb
+
+(`msg`) => `void` \| `Promise`\<`void`\>
+
+##### Returns
+
+`this`
+
+#### Call Signature
+
+> **on**(`event`, `cb`): `this`
+
+Defined in: [lib/ws.ts:264](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L264)
+
+绑定监听
+
+##### Parameters
+
+###### event
+
+`"error"`
+
+###### cb
+
+(`error`) => `void` \| `Promise`\<`void`\>
+
+##### Returns
+
+`this`
+
+#### Call Signature
+
+> **on**(`event`, `cb`): `this`
+
+Defined in: [lib/ws.ts:265](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L265)
+
+绑定监听
+
+##### Parameters
+
+###### event
+
+`"end"` | `"close"` | `"drain"`
+
+###### cb
+
+() => `void` \| `Promise`\<`void`\>
+
+##### Returns
+
+`this`
+
+***
+
+### ping()
+
+> **ping**(`data?`): `boolean`
+
+Defined in: [lib/ws.ts:355](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L355)
+
+发送 ping
+
+#### Parameters
+
+##### data?
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### Returns
+
+`boolean`
+
+***
+
+### pong()
+
+> **pong**(`data?`): `boolean`
+
+Defined in: [lib/ws.ts:366](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L366)
+
+发送 ping
+
+#### Parameters
+
+##### data?
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### Returns
+
+`boolean`
+
+***
+
+### writeBinary()
+
+> **writeBinary**(`data`): `boolean`
+
+Defined in: [lib/ws.ts:325](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L325)
+
+发送二进制
+
+#### Parameters
+
+##### data
+
+`string` | `Buffer`\<`ArrayBufferLike`\> | (`string` \| `Buffer`\<`ArrayBufferLike`\>)[]
+
+#### Returns
+
+`boolean`
+
+***
+
+### writeResult()
+
+> **writeResult**(`data`): `boolean`
+
+Defined in: [lib/ws.ts:317](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L317)
+
+发送结果对象字符串
+
+#### Parameters
+
+##### data
+
+`any`
+
+#### Returns
+
+`boolean`
+
+***
+
+### writeText()
+
+> **writeText**(`data`): `boolean`
+
+Defined in: [lib/ws.ts:309](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L309)
+
+发送文本
+
+#### Parameters
+
+##### data
+
+`string` | `Buffer`\<`ArrayBufferLike`\> | (`string` \| `Buffer`\<`ArrayBufferLike`\>)[]
+
+#### Returns
+
+`boolean`

package/doc/sc/api/lib/ws/enumerations/EFrameReceiveMode.md

@@ -0,0 +1,35 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ws](../index.md) / EFrameReceiveMode
+
+# Enumeration: EFrameReceiveMode
+
+Defined in: [lib/ws.ts:17](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L17)
+
+一般用 SIMPLE
+
+## Enumeration Members
+
+### LITE
+
+> **LITE**: `1`
+
+Defined in: [lib/ws.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L19)
+
+***
+
+### SIMPLE
+
+> **SIMPLE**: `2`
+
+Defined in: [lib/ws.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L20)
+
+***
+
+### STANDARD
+
+> **STANDARD**: `0`
+
+Defined in: [lib/ws.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L18)

package/doc/sc/api/lib/ws/enumerations/EOpcode.md

@@ -0,0 +1,59 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ws](../index.md) / EOpcode
+
+# Enumeration: EOpcode
+
+Defined in: [lib/ws.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L24)
+
+OPCODE
+
+## Enumeration Members
+
+### BINARY
+
+> **BINARY**: `2`
+
+Defined in: [lib/ws.ts:27](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L27)
+
+***
+
+### CLOSE
+
+> **CLOSE**: `8`
+
+Defined in: [lib/ws.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L28)
+
+***
+
+### CONTINUATION
+
+> **CONTINUATION**: `0`
+
+Defined in: [lib/ws.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L25)
+
+***
+
+### PING
+
+> **PING**: `9`
+
+Defined in: [lib/ws.ts:29](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L29)
+
+***
+
+### PONG
+
+> **PONG**: `10`
+
+Defined in: [lib/ws.ts:30](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L30)
+
+***
+
+### TEXT
+
+> **TEXT**: `1`
+
+Defined in: [lib/ws.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L26)

package/doc/sc/api/lib/ws/functions/connect.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ws](../index.md) / connect
+
+# Function: connect()
+
+> **connect**(`u`, `opt`): `Promise`\<[`Socket`](../classes/Socket.md) \| `null`\>
+
+Defined in: [lib/ws.ts:383](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L383)
+
+创建一个 ws 客户端发起 ws 请求
+
+## Parameters
+
+### u
+
+`string`
+
+以 ws, wss 开头的地址
+
+### opt
+
+[`IConnectOptions`](../interfaces/IConnectOptions.md) = `{}`
+
+参数
+
+## Returns
+
+`Promise`\<[`Socket`](../classes/Socket.md) \| `null`\>

package/doc/sc/api/lib/ws/functions/createServer.md

@@ -0,0 +1,45 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ws](../index.md) / createServer
+
+# Function: createServer()
+
+> **createServer**(`request`, `socket`, `head?`, `options?`): [`Socket`](../classes/Socket.md)
+
+Defined in: [lib/ws.ts:393](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L393)
+
+创建一个 ws 服务器接收处理器
+
+## Parameters
+
+### request
+
+`IncomingMessage`
+
+Http 请求端
+
+### socket
+
+`Socket`
+
+响应双向 socket
+
+### head?
+
+`Buffer`\<`ArrayBufferLike`\>
+
+### options?
+
+#### headers?
+
+`OutgoingHttpHeaders`
+
+#### timeout?
+
+`number`
+
+## Returns
+
+[`Socket`](../classes/Socket.md)

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

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

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

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ws](../index.md) / rproxy
+
+# Function: rproxy()
+
+> **rproxy**(`ctr`, `url`, `opt`): `Promise`\<`boolean`\>
+
+Defined in: [lib/ws.ts:518](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L518)
+
+反向代理，将本 socket 连接反代到其他网址，在 ws 的 onLoad 事件中使用
+
+## Parameters
+
+### ctr
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+当前控制器
+
+### url
+
+`string`
+
+反代真实请求地址，如有 get 需要自行添加
+
+### opt
+
+[`IRproxyOptions`](../interfaces/IRproxyOptions.md) = `{}`
+
+参数
+
+## Returns
+
+`Promise`\<`boolean`\>

package/doc/sc/api/lib/ws/functions/rsocket.md

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ws](../index.md) / rsocket
+
+# Function: rsocket()
+
+> **rsocket**(`ctr`, `host`, `port`): `Promise`\<`boolean`\>
+
+Defined in: [lib/ws.ts:547](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L547)
+
+反向代理，将本 websocket 连接反代到其他真正的 socket，在 ws 的 onLoad 事件中使用
+
+## Parameters
+
+### ctr
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+当前控制器
+
+### host
+
+`string`
+
+反代真实请求地址
+
+### port
+
+`number`
+
+反代真实请求端口
+
+## Returns
+
+`Promise`\<`boolean`\>

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

@@ -0,0 +1,30 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/ws
+
+# lib/ws
+
+## Enumerations
+
+- [EFrameReceiveMode](enumerations/EFrameReceiveMode.md)
+- [EOpcode](enumerations/EOpcode.md)
+
+## Classes
+
+- [Socket](classes/Socket.md)
+
+## Interfaces
+
+- [IConnectOptions](interfaces/IConnectOptions.md)
+- [IMproxyOptions](interfaces/IMproxyOptions.md)
+- [IRproxyOptions](interfaces/IRproxyOptions.md)
+
+## Functions
+
+- [connect](functions/connect.md)
+- [createServer](functions/createServer.md)
+- [mproxy](functions/mproxy.md)
+- [rproxy](functions/rproxy.md)
+- [rsocket](functions/rsocket.md)