@next-core/next-docs 1.2.467 → 1.2.469

package/dist/brick-kit.createwebsocket.md

@@ -0,0 +1,19 @@
+---
+id: brick-kit.createwebsocket
+title: createWebSocket
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [createWebSocket](./brick-kit.createwebsocket.md)
+
+## createWebSocket variable
+
+**Signature:**
+
+```typescript
+createWebSocket: () => WebSocketService
+```
+

package/dist/brick-kit.getwebsocket.md

@@ -0,0 +1,23 @@
+---
+id: brick-kit.getwebsocket
+title: getWebSocket()
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [getWebSocket](./brick-kit.getwebsocket.md)
+
+## getWebSocket() function
+
+**Signature:**
+
+```typescript
+export declare function getWebSocket(): WebSocketService;
+```
+
+**Returns:**
+
+WebSocketService
+

package/dist/brick-kit.md

@@ -19,6 +19,8 @@ The core kit of Brick Next.
 |  --- | --- |
 |  [ModalElement](./brick-kit.modalelement.md) | 模态框类构件的抽象基类。 |
 |  [UpdatingElement](./brick-kit.updatingelement.md) | 普通构件的抽象基类。 |
+|  [WebsocketMessageRequest](./brick-kit.websocketmessagerequest.md) |  |
+|  [WebsocketMessageResponse](./brick-kit.websocketmessageresponse.md) |  |
 
 ## Functions
 
@@ -39,6 +41,7 @@ The core kit of Brick Next.
 |  [getRealValue](./brick-kit.getrealvalue.md) | An equivalent of <code>computeRealValue</code> but for external usages, with no custom context or options. |
 |  [getRuntime](./brick-kit.getruntime.md) | 获取系统运行时对象。 |
 |  [getRuntimeMisc](./brick-kit.getruntimemisc.md) |  |
+|  [getWebSocket](./brick-kit.getwebsocket.md) |  |
 |  [handleHttpError](./brick-kit.handlehttperror.md) | 处理 http 请求错误（使用 AntDesign 模态框弹出错误信息）。 |
 |  [httpErrorToString](./brick-kit.httperrortostring.md) | 将 http 请求错误转换为可读的字符串。 |
 |  [i18nText](./brick-kit.i18ntext.md) |  |
@@ -73,6 +76,7 @@ The core kit of Brick Next.
 
 |  Variable | Description |
 |  --- | --- |
+|  [createWebSocket](./brick-kit.createwebsocket.md) |  |
 |  [FeatureFlagsProvider](./brick-kit.featureflagsprovider.md) |  |
 |  [ForwardRefSingleBrickAsComponent](./brick-kit.forwardrefsinglebrickascomponent.md) |  |
 |  [getMockInfo](./brick-kit.getmockinfo.md) |  |

package/dist/brick-kit.websocketmessagerequest._constructor_.md

@@ -0,0 +1,28 @@
+---
+id: brick-kit.websocketmessagerequest._constructor_
+title: WebsocketMessageRequest.(constructor)
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageRequest](./brick-kit.websocketmessagerequest.md) &gt; [(constructor)](./brick-kit.websocketmessagerequest._constructor_.md)
+
+## WebsocketMessageRequest.(constructor)
+
+Constructs a new instance of the `WebsocketMessageRequest` class
+
+**Signature:**
+
+```typescript
+constructor(event: PluginWebSocketMessageEvent, topic: PluginWebSocketMessageTopic);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  event | PluginWebSocketMessageEvent |  |
+|  topic | PluginWebSocketMessageTopic |  |
+

package/dist/brick-kit.websocketmessagerequest.data.md

@@ -0,0 +1,19 @@
+---
+id: brick-kit.websocketmessagerequest.data
+title: WebsocketMessageRequest.data
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageRequest](./brick-kit.websocketmessagerequest.md) &gt; [data](./brick-kit.websocketmessagerequest.data.md)
+
+## WebsocketMessageRequest.data property
+
+**Signature:**
+
+```typescript
+data: string;
+```
+

package/dist/brick-kit.websocketmessagerequest.event.md

@@ -0,0 +1,19 @@
+---
+id: brick-kit.websocketmessagerequest.event
+title: WebsocketMessageRequest.event
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageRequest](./brick-kit.websocketmessagerequest.md) &gt; [event](./brick-kit.websocketmessagerequest.event.md)
+
+## WebsocketMessageRequest.event property
+
+**Signature:**
+
+```typescript
+event: PluginWebSocketMessageEvent;
+```
+

package/dist/brick-kit.websocketmessagerequest.identity.md

@@ -0,0 +1,19 @@
+---
+id: brick-kit.websocketmessagerequest.identity
+title: WebsocketMessageRequest.identity
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageRequest](./brick-kit.websocketmessagerequest.md) &gt; [identity](./brick-kit.websocketmessagerequest.identity.md)
+
+## WebsocketMessageRequest.identity property
+
+**Signature:**
+
+```typescript
+get identity(): string;
+```
+

package/dist/brick-kit.websocketmessagerequest.md

@@ -0,0 +1,35 @@
+---
+id: brick-kit.websocketmessagerequest
+title: WebsocketMessageRequest
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageRequest](./brick-kit.websocketmessagerequest.md)
+
+## WebsocketMessageRequest class
+
+**Signature:**
+
+```typescript
+export declare class WebsocketMessageRequest
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(event, topic)](./brick-kit.websocketmessagerequest._constructor_.md) |  | Constructs a new instance of the <code>WebsocketMessageRequest</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [data](./brick-kit.websocketmessagerequest.data.md) |  | string |  |
+|  [event](./brick-kit.websocketmessagerequest.event.md) |  | PluginWebSocketMessageEvent |  |
+|  [identity](./brick-kit.websocketmessagerequest.identity.md) |  | string |  |
+|  [message](./brick-kit.websocketmessagerequest.message.md) |  | PluginWebSocketMessage&lt;PluginWebSocketMessageTopic&gt; |  |
+|  [topic](./brick-kit.websocketmessagerequest.topic.md) |  | string |  |
+

package/dist/brick-kit.websocketmessagerequest.message.md

@@ -0,0 +1,19 @@
+---
+id: brick-kit.websocketmessagerequest.message
+title: WebsocketMessageRequest.message
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageRequest](./brick-kit.websocketmessagerequest.md) &gt; [message](./brick-kit.websocketmessagerequest.message.md)
+
+## WebsocketMessageRequest.message property
+
+**Signature:**
+
+```typescript
+message: PluginWebSocketMessage<PluginWebSocketMessageTopic>;
+```
+

package/dist/brick-kit.websocketmessagerequest.topic.md

@@ -0,0 +1,19 @@
+---
+id: brick-kit.websocketmessagerequest.topic
+title: WebsocketMessageRequest.topic
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageRequest](./brick-kit.websocketmessagerequest.md) &gt; [topic](./brick-kit.websocketmessagerequest.topic.md)
+
+## WebsocketMessageRequest.topic property
+
+**Signature:**
+
+```typescript
+topic: string;
+```
+

package/dist/brick-kit.websocketmessageresponse._constructor_.md

@@ -0,0 +1,27 @@
+---
+id: brick-kit.websocketmessageresponse._constructor_
+title: WebsocketMessageResponse.(constructor)
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageResponse](./brick-kit.websocketmessageresponse.md) &gt; [(constructor)](./brick-kit.websocketmessageresponse._constructor_.md)
+
+## WebsocketMessageResponse.(constructor)
+
+Constructs a new instance of the `WebsocketMessageResponse` class
+
+**Signature:**
+
+```typescript
+constructor(response: string);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  response | string |  |
+

package/dist/brick-kit.websocketmessageresponse.data.md

@@ -0,0 +1,19 @@
+---
+id: brick-kit.websocketmessageresponse.data
+title: WebsocketMessageResponse.data
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageResponse](./brick-kit.websocketmessageresponse.md) &gt; [data](./brick-kit.websocketmessageresponse.data.md)
+
+## WebsocketMessageResponse.data property
+
+**Signature:**
+
+```typescript
+data: string;
+```
+

package/dist/brick-kit.websocketmessageresponse.event.md

@@ -0,0 +1,19 @@
+---
+id: brick-kit.websocketmessageresponse.event
+title: WebsocketMessageResponse.event
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageResponse](./brick-kit.websocketmessageresponse.md) &gt; [event](./brick-kit.websocketmessageresponse.event.md)
+
+## WebsocketMessageResponse.event property
+
+**Signature:**
+
+```typescript
+event: PluginWebSocketMessageEvent;
+```
+

package/dist/brick-kit.websocketmessageresponse.identity.md

@@ -0,0 +1,19 @@
+---
+id: brick-kit.websocketmessageresponse.identity
+title: WebsocketMessageResponse.identity
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageResponse](./brick-kit.websocketmessageresponse.md) &gt; [identity](./brick-kit.websocketmessageresponse.identity.md)
+
+## WebsocketMessageResponse.identity property
+
+**Signature:**
+
+```typescript
+get identity(): string;
+```
+

package/dist/brick-kit.websocketmessageresponse.md

@@ -0,0 +1,35 @@
+---
+id: brick-kit.websocketmessageresponse
+title: WebsocketMessageResponse
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageResponse](./brick-kit.websocketmessageresponse.md)
+
+## WebsocketMessageResponse class
+
+**Signature:**
+
+```typescript
+export declare class WebsocketMessageResponse
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(response)](./brick-kit.websocketmessageresponse._constructor_.md) |  | Constructs a new instance of the <code>WebsocketMessageResponse</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [data](./brick-kit.websocketmessageresponse.data.md) |  | string |  |
+|  [event](./brick-kit.websocketmessageresponse.event.md) |  | PluginWebSocketMessageEvent |  |
+|  [identity](./brick-kit.websocketmessageresponse.identity.md) |  | string |  |
+|  [message](./brick-kit.websocketmessageresponse.message.md) |  | PluginWebSocketMessage&lt;PluginWebSocketMessageResponsePayload&gt; |  |
+|  [topic](./brick-kit.websocketmessageresponse.topic.md) |  | string |  |
+

package/dist/brick-kit.websocketmessageresponse.message.md

@@ -0,0 +1,19 @@
+---
+id: brick-kit.websocketmessageresponse.message
+title: WebsocketMessageResponse.message
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageResponse](./brick-kit.websocketmessageresponse.md) &gt; [message](./brick-kit.websocketmessageresponse.message.md)
+
+## WebsocketMessageResponse.message property
+
+**Signature:**
+
+```typescript
+message: PluginWebSocketMessage<PluginWebSocketMessageResponsePayload>;
+```
+

package/dist/brick-kit.websocketmessageresponse.topic.md

@@ -0,0 +1,19 @@
+---
+id: brick-kit.websocketmessageresponse.topic
+title: WebsocketMessageResponse.topic
+hide_title: true
+custom_edit_url: null
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[API Reference](./index.md) &gt; [@next-core/brick-kit](./brick-kit.md) &gt; [WebsocketMessageResponse](./brick-kit.websocketmessageresponse.md) &gt; [topic](./brick-kit.websocketmessageresponse.topic.md)
+
+## WebsocketMessageResponse.topic property
+
+**Signature:**
+
+```typescript
+topic: string;
+```
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-core/next-docs",
-  "version": "1.2.467",
+  "version": "1.2.469",
   "description": "> TODO: description",
   "homepage": "https://github.com/easyops-cn/next-core/tree/master/packages/next-docs",
   "license": "GPL-3.0",
@@ -32,9 +32,9 @@
   "sideEffects": false,
   "devDependencies": {
     "@easyops-cn/brick-next-pipes": "^0.4.0",
-    "@next-core/brick-kit": "^2.177.3",
+    "@next-core/brick-kit": "^2.178.0",
     "@next-core/brick-types": "^2.89.0",
     "fs-extra": "^10.1.0"
   },
-  "gitHead": "be1e90484873d1828419a7b9f94bf0302b944b05"
+  "gitHead": "ddd65a1f708947893a82ac322ca1999d801dd68d"
 }