@maiyunnet/kebab 7.6.0 → 7.6.1

package/doc/sc/api/lib/scan/interfaces/IStaticOptions.md

@@ -0,0 +1,35 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/scan](../index.md) / IStaticOptions
+
+# Interface: IStaticOptions
+
+Defined in: [lib/scan.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L38)
+
+scanned 函数的选项
+
+## Properties
+
+### ctr?
+
+> `optional` **ctr**: [`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+Defined in: [lib/scan.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L39)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [lib/scan.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L41)
+
+***
+
+### pre?
+
+> `optional` **pre**: `string`
+
+Defined in: [lib/scan.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L40)

package/doc/sc/api/lib/session/classes/Session.md

@@ -0,0 +1,103 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/session](../index.md) / Session
+
+# Class: Session
+
+Defined in: [lib/session.ts:37](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L37)
+
+## Constructors
+
+### Constructor
+
+> **new Session**(): `Session`
+
+#### Returns
+
+`Session`
+
+## Methods
+
+### getName()
+
+> **getName**(): `string`
+
+Defined in: [lib/session.ts:201](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L201)
+
+获取当前的 cookie 的 name 值
+
+#### Returns
+
+`string`
+
+***
+
+### getToken()
+
+> **getToken**(): `string`
+
+Defined in: [lib/session.ts:194](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L194)
+
+获取当前的 token 值
+
+#### Returns
+
+`string`
+
+***
+
+### init()
+
+> **init**(`ctr`, `link`, `auth`, `opt`): `Promise`\<`boolean`\>
+
+Defined in: [lib/session.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L65)
+
+初始化函数，相当于 construct
+
+#### Parameters
+
+##### ctr
+
+[`Ctr`](../../../sys/ctr/classes/Ctr.md)
+
+模型实例
+
+##### link
+
+Kv 或 Db 实例
+
+[`Pool`](../../db/pool/classes/Pool.md) | [`Kv`](../../kv/classes/Kv.md)
+
+##### auth
+
+`boolean` = `false`
+
+设为 true 则优先从头 Authorization 或 post _auth 值读取 token
+
+##### opt
+
+[`IOptions`](../interfaces/IOptions.md) = `{}`
+
+选项
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+false 表示系统错误
+
+***
+
+### update()
+
+> **update**(): `Promise`\<`void`\>
+
+Defined in: [lib/session.ts:208](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L208)
+
+页面整体结束时，要写入到 Kv 或 数据库
+
+#### Returns
+
+`Promise`\<`void`\>

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

@@ -0,0 +1,15 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/session
+
+# lib/session
+
+## Classes
+
+- [Session](classes/Session.md)
+
+## Interfaces
+
+- [IOptions](interfaces/IOptions.md)

package/doc/sc/api/lib/session/interfaces/IOptions.md

@@ -0,0 +1,41 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/session](../index.md) / IOptions
+
+# Interface: IOptions
+
+Defined in: [lib/session.ts:30](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L30)
+
+## Properties
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [lib/session.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L31)
+
+***
+
+### sqlPre?
+
+> `optional` **sqlPre**: `string`
+
+Defined in: [lib/session.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L34)
+
+***
+
+### ssl?
+
+> `optional` **ssl**: `boolean`
+
+Defined in: [lib/session.ts:33](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L33)
+
+***
+
+### ttl?
+
+> `optional` **ttl**: `number`
+
+Defined in: [lib/session.ts:32](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L32)

package/doc/sc/api/lib/socket/functions/rwebsocket.md

@@ -0,0 +1,37 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/socket](../index.md) / rwebsocket
+
+# Function: rwebsocket()
+
+> **rwebsocket**(`port`, `url`, `opt`): `Server`
+
+Defined in: [lib/socket.ts:37](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L37)
+
+创建一个 Socket 服务器并反代到 WebSocket
+
+## Parameters
+
+### port
+
+`number`
+
+监听端口
+
+### url
+
+`string`
+
+反代到的 WebSocket
+
+### opt
+
+[`IRwebsocketOptions`](../interfaces/IRwebsocketOptions.md) = `{}`
+
+选项
+
+## Returns
+
+`Server`

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

@@ -0,0 +1,15 @@
+[**Documents for @maiyunnet/kebab**](../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../index.md) / lib/socket
+
+# lib/socket
+
+## Interfaces
+
+- [IRwebsocketOptions](interfaces/IRwebsocketOptions.md)
+
+## Functions
+
+- [rwebsocket](functions/rwebsocket.md)

package/doc/sc/api/lib/socket/interfaces/IRwebsocketOptions.md

@@ -0,0 +1,91 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/socket](../index.md) / IRwebsocketOptions
+
+# Interface: IRwebsocketOptions
+
+Defined in: [lib/socket.ts:12](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L12)
+
+## Properties
+
+### cookie?
+
+> `optional` **cookie**: `Record`\<`string`, [`ICookie`](../../net/interfaces/ICookie.md)\>
+
+Defined in: [lib/socket.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L19)
+
+cookie 托管对象
+
+***
+
+### headers?
+
+> `optional` **headers**: [`THttpHeaders`](../../net/type-aliases/THttpHeaders.md)
+
+Defined in: [lib/socket.ts:17](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L17)
+
+***
+
+### hosts?
+
+> `optional` **hosts**: `Record`\<`string`, `string`\>
+
+Defined in: [lib/socket.ts:15](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L15)
+
+***
+
+### local?
+
+> `optional` **local**: `string`
+
+Defined in: [lib/socket.ts:16](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L16)
+
+***
+
+### masking?
+
+> `optional` **masking**: `boolean`
+
+Defined in: [lib/socket.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L23)
+
+加密模式，默认 true
+
+***
+
+### mode?
+
+> `optional` **mode**: [`EFrameReceiveMode`](../../ws/enumerations/EFrameReceiveMode.md)
+
+Defined in: [lib/socket.ts:21](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L21)
+
+小帧模式，默认 false
+
+***
+
+### mproxy?
+
+> `optional` **mproxy**: `object`
+
+Defined in: [lib/socket.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L25)
+
+正向 mproxy 代理，url 如 wss://xxx/abc
+
+#### auth
+
+> **auth**: `string`
+
+#### url
+
+> **url**: `string`
+
+***
+
+### timeout?
+
+> `optional` **timeout**: `number`
+
+Defined in: [lib/socket.ts:14](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L14)
+
+秒数