@next-core/next-docs 1.2.569 → 1.2.571

package/dist/brick-types.pluginruntimecontext.segues.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.pluginruntimecontext.segues
+title: PluginRuntimeContext.segues
+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-types](./brick-types.md) &gt; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) &gt; [segues](./brick-types.pluginruntimecontext.segues.md)
+
+## PluginRuntimeContext.segues property
+
+当前应用的页面切换配置。
+
+**Signature:**
+
+```typescript
+segues?: SeguesConf;
+```
+
+**Reference:** [SeguesConf](./brick-types.seguesconf.md)
+

package/dist/brick-types.pluginruntimecontext.sys.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.pluginruntimecontext.sys
+title: PluginRuntimeContext.sys
+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-types](./brick-types.md) &gt; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) &gt; [sys](./brick-types.pluginruntimecontext.sys.md)
+
+## PluginRuntimeContext.sys property
+
+系统会话信息。
+
+**Signature:**
+
+```typescript
+sys?: SystemInfo;
+```
+
+**Reference:** [SystemInfo](./brick-types.systeminfo.md)
+

package/dist/brick-types.providerconf.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.providerconf
+title: ProviderConf
+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-types](./brick-types.md) &gt; [ProviderConf](./brick-types.providerconf.md)
+
+## ProviderConf interface
+
+Provider 配置。
+
+**Signature:**
+
+```typescript
+export declare type ProviderConf = string | Pick<BrickConf, "brick" | "properties" | "events" | "lifeCycle">;
+```
+
+**Reference:** [BrickConf](./brick-types.brickconf.md)
+

package/dist/brick-types.providerpolloptions.continueonerror.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.providerpolloptions.continueonerror
+title: ProviderPollOptions.continueOnError
+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-types](./brick-types.md) &gt; [ProviderPollOptions](./brick-types.providerpolloptions.md) &gt; [continueOnError](./brick-types.providerpolloptions.continueonerror.md)
+
+## ProviderPollOptions.continueOnError property
+
+当轮询出现错误时，是否继续轮询。
+
+**Signature:**
+
+```typescript
+continueOnError?: boolean;
+```
+

package/dist/brick-types.providerpolloptions.delegateloadingbar.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.providerpolloptions.delegateloadingbar
+title: ProviderPollOptions.delegateLoadingBar
+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-types](./brick-types.md) &gt; [ProviderPollOptions](./brick-types.providerpolloptions.md) &gt; [delegateLoadingBar](./brick-types.providerpolloptions.delegateloadingbar.md)
+
+## ProviderPollOptions.delegateLoadingBar property
+
+是否代理系统加载条的显示与隐藏。应配合 `expectPollEnd` 使用。
+
+**Signature:**
+
+```typescript
+delegateLoadingBar?: boolean;
+```
+

package/dist/brick-types.providerpolloptions.else.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.providerpolloptions.else
+title: ProviderPollOptions.else
+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-types](./brick-types.md) &gt; [ProviderPollOptions](./brick-types.providerpolloptions.md) &gt; [else](./brick-types.providerpolloptions.else.md)
+
+## ProviderPollOptions.else property
+
+不满足条件分支
+
+**Signature:**
+
+```typescript
+else?: BrickEventHandler | BrickEventHandler[];
+```
+
+**Reference:** [BrickEventHandler](./brick-types.brickeventhandler.md)
+

package/dist/brick-types.providerpolloptions.enabled.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.providerpolloptions.enabled
+title: ProviderPollOptions.enabled
+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-types](./brick-types.md) &gt; [ProviderPollOptions](./brick-types.providerpolloptions.md) &gt; [enabled](./brick-types.providerpolloptions.enabled.md)
+
+## ProviderPollOptions.enabled property
+
+是否启用轮询。
+
+**Signature:**
+
+```typescript
+enabled?: boolean;
+```
+

package/dist/brick-types.providerpolloptions.expectpollend.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.providerpolloptions.expectpollend
+title: ProviderPollOptions.expectPollEnd
+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-types](./brick-types.md) &gt; [ProviderPollOptions](./brick-types.providerpolloptions.md) &gt; [expectPollEnd](./brick-types.providerpolloptions.expectpollend.md)
+
+## ProviderPollOptions.expectPollEnd property
+
+提供一个方法以校验轮询是否应该结束。 该方法接收一个参数：当前轮询的执行结果。 轮询结束时将触发 `callback.success` 事件。
+
+**Signature:**
+
+```typescript
+expectPollEnd?: (result: unknown) => boolean;
+```
+

package/dist/brick-types.providerpolloptions.expectpollstopimmediately.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.providerpolloptions.expectpollstopimmediately
+title: ProviderPollOptions.expectPollStopImmediately
+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-types](./brick-types.md) &gt; [ProviderPollOptions](./brick-types.providerpolloptions.md) &gt; [expectPollStopImmediately](./brick-types.providerpolloptions.expectpollstopimmediately.md)
+
+## ProviderPollOptions.expectPollStopImmediately property
+
+提供一个方法以校验轮询是否应该立即停止，还在等待或进行中的轮询将失效， 会触发 `finally` 事件，不会触发 `progress|success|error` 等事件。
+
+**Signature:**
+
+```typescript
+expectPollStopImmediately?: () => boolean;
+```
+

package/dist/brick-types.providerpolloptions.interval.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.providerpolloptions.interval
+title: ProviderPollOptions.interval
+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-types](./brick-types.md) &gt; [ProviderPollOptions](./brick-types.providerpolloptions.md) &gt; [interval](./brick-types.providerpolloptions.interval.md)
+
+## ProviderPollOptions.interval property
+
+每次轮询间隔时间（毫秒），默认为 `3000`<!-- -->。
+
+**Signature:**
+
+```typescript
+interval?: number;
+```
+

package/dist/brick-types.providerpolloptions.leadingrequestdelay.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.providerpolloptions.leadingrequestdelay
+title: ProviderPollOptions.leadingRequestDelay
+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-types](./brick-types.md) &gt; [ProviderPollOptions](./brick-types.providerpolloptions.md) &gt; [leadingRequestDelay](./brick-types.providerpolloptions.leadingrequestdelay.md)
+
+## ProviderPollOptions.leadingRequestDelay property
+
+第一次轮询延迟时间（毫秒），默认为 `0`<!-- -->。
+
+**Signature:**
+
+```typescript
+leadingRequestDelay?: number;
+```
+

package/dist/brick-types.providerpolloptions.md

@@ -0,0 +1,34 @@
+---
+id: brick-types.providerpolloptions
+title: ProviderPollOptions
+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-types](./brick-types.md) &gt; [ProviderPollOptions](./brick-types.providerpolloptions.md)
+
+## ProviderPollOptions interface
+
+使用 Provider 进行轮询时的选项配置。
+
+**Signature:**
+
+```typescript
+export interface ProviderPollOptions
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [continueOnError](./brick-types.providerpolloptions.continueonerror.md) | boolean | 当轮询出现错误时，是否继续轮询。 |
+|  [delegateLoadingBar](./brick-types.providerpolloptions.delegateloadingbar.md) | boolean | 是否代理系统加载条的显示与隐藏。应配合 <code>expectPollEnd</code> 使用。 |
+|  [else](./brick-types.providerpolloptions.else.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 不满足条件分支 |
+|  [enabled](./brick-types.providerpolloptions.enabled.md) | boolean | 是否启用轮询。 |
+|  [expectPollEnd](./brick-types.providerpolloptions.expectpollend.md) | (result: unknown) =&gt; boolean | 提供一个方法以校验轮询是否应该结束。 该方法接收一个参数：当前轮询的执行结果。 轮询结束时将触发 <code>callback.success</code> 事件。 |
+|  [expectPollStopImmediately](./brick-types.providerpolloptions.expectpollstopimmediately.md) | () =&gt; boolean | 提供一个方法以校验轮询是否应该立即停止，还在等待或进行中的轮询将失效， 会触发 <code>finally</code> 事件，不会触发 <code>progress&#124;success&#124;error</code> 等事件。 |
+|  [interval](./brick-types.providerpolloptions.interval.md) | number | 每次轮询间隔时间（毫秒），默认为 <code>3000</code>。 |
+|  [leadingRequestDelay](./brick-types.providerpolloptions.leadingrequestdelay.md) | number | 第一次轮询延迟时间（毫秒），默认为 <code>0</code>。 |
+

package/dist/brick-types.refinedantdicon.color.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.refinedantdicon.color
+title: RefinedAntdIcon.color
+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-types](./brick-types.md) &gt; [RefinedAntdIcon](./brick-types.refinedantdicon.md) &gt; [color](./brick-types.refinedantdicon.color.md)
+
+## RefinedAntdIcon.color property
+
+**Signature:**
+
+```typescript
+color?: string | GradientColor;
+```
+
+**Reference:** [GradientColor](./brick-types.gradientcolor.md)
+

package/dist/brick-types.refinedantdicon.icon.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.refinedantdicon.icon
+title: RefinedAntdIcon.icon
+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-types](./brick-types.md) &gt; [RefinedAntdIcon](./brick-types.refinedantdicon.md) &gt; [icon](./brick-types.refinedantdicon.icon.md)
+
+## RefinedAntdIcon.icon property
+
+**Signature:**
+
+```typescript
+icon: string;
+```
+

package/dist/brick-types.refinedantdicon.lib.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.refinedantdicon.lib
+title: RefinedAntdIcon.lib
+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-types](./brick-types.md) &gt; [RefinedAntdIcon](./brick-types.refinedantdicon.md) &gt; [lib](./brick-types.refinedantdicon.lib.md)
+
+## RefinedAntdIcon.lib property
+
+**Signature:**
+
+```typescript
+lib: "antd";
+```
+

package/dist/brick-types.refinedantdicon.md

@@ -0,0 +1,30 @@
+---
+id: brick-types.refinedantdicon
+title: RefinedAntdIcon
+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-types](./brick-types.md) &gt; [RefinedAntdIcon](./brick-types.refinedantdicon.md)
+
+## RefinedAntdIcon interface
+
+优化后的 Antd 图标配置。
+
+**Signature:**
+
+```typescript
+export interface RefinedAntdIcon
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [color](./brick-types.refinedantdicon.color.md) | string \| [GradientColor](./brick-types.gradientcolor.md) |  |
+|  [icon](./brick-types.refinedantdicon.icon.md) | string |  |
+|  [lib](./brick-types.refinedantdicon.lib.md) | "antd" |  |
+|  [theme](./brick-types.refinedantdicon.theme.md) | ThemeType |  |
+

package/dist/brick-types.refinedantdicon.theme.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.refinedantdicon.theme
+title: RefinedAntdIcon.theme
+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-types](./brick-types.md) &gt; [RefinedAntdIcon](./brick-types.refinedantdicon.md) &gt; [theme](./brick-types.refinedantdicon.theme.md)
+
+## RefinedAntdIcon.theme property
+
+**Signature:**
+
+```typescript
+theme?: ThemeType;
+```
+

package/dist/brick-types.refresolveconf.md

@@ -0,0 +1,25 @@
+---
+id: brick-types.refresolveconf
+title: RefResolveConf
+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-types](./brick-types.md) &gt; [RefResolveConf](./brick-types.refresolveconf.md)
+
+## RefResolveConf interface
+
+引用类的异步数据处理配置。
+
+**Signature:**
+
+```typescript
+export declare type RefResolveConf = Pick<BaseEntityResolveConf, "name" | "transformFrom" | "transformMapArray" | "transform" | "onReject" | "if"> & {
+    ref: string;
+};
+```
+
+**Reference:** [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md)
+

package/dist/brick-types.resolveconf.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.resolveconf
+title: ResolveConf
+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-types](./brick-types.md) &gt; [ResolveConf](./brick-types.resolveconf.md)
+
+## ResolveConf interface
+
+异步数据处理配置。
+
+**Signature:**
+
+```typescript
+export declare type ResolveConf = EntityResolveConf | RefResolveConf;
+```
+
+**Reference:** [EntityResolveConf](./brick-types.entityresolveconf.md)<!-- -->, [RefResolveConf](./brick-types.refresolveconf.md)
+

package/dist/brick-types.resolvemenuconf.md

@@ -0,0 +1,28 @@
+---
+id: brick-types.resolvemenuconf
+title: ResolveMenuConf
+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-types](./brick-types.md) &gt; [ResolveMenuConf](./brick-types.resolvemenuconf.md)
+
+## ResolveMenuConf interface
+
+使用异步数据处理的菜单配置。
+
+**Signature:**
+
+```typescript
+export interface ResolveMenuConf
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [resolve](./brick-types.resolvemenuconf.resolve.md) | [ResolveConf](./brick-types.resolveconf.md) | 异步数据处理配置。 |
+|  [type](./brick-types.resolvemenuconf.type.md) | "resolve" |  |
+

package/dist/brick-types.resolvemenuconf.resolve.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.resolvemenuconf.resolve
+title: ResolveMenuConf.resolve
+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-types](./brick-types.md) &gt; [ResolveMenuConf](./brick-types.resolvemenuconf.md) &gt; [resolve](./brick-types.resolvemenuconf.resolve.md)
+
+## ResolveMenuConf.resolve property
+
+异步数据处理配置。
+
+**Signature:**
+
+```typescript
+resolve: ResolveConf;
+```
+
+**Reference:** [ResolveConf](./brick-types.resolveconf.md)
+

package/dist/brick-types.resolvemenuconf.type.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.resolvemenuconf.type
+title: ResolveMenuConf.type
+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-types](./brick-types.md) &gt; [ResolveMenuConf](./brick-types.resolvemenuconf.md) &gt; [type](./brick-types.resolvemenuconf.type.md)
+
+## ResolveMenuConf.type property
+
+**Signature:**
+
+```typescript
+type: "resolve";
+```
+

package/dist/brick-types.routeconf.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.routeconf
+title: RouteConf
+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-types](./brick-types.md) &gt; [RouteConf](./brick-types.routeconf.md)
+
+## RouteConf interface
+
+路由配置，类型可以是构件列表、子路由列表和重定向中的一种。
+
+**Signature:**
+
+```typescript
+export declare type RouteConf = RouteConfOfBricks | RouteConfOfRoutes | RouteConfOfRedirect;
+```
+
+**Reference:** [RouteConfOfBricks](./brick-types.routeconfofbricks.md)<!-- -->, [RouteConfOfRoutes](./brick-types.routeconfofroutes.md)<!-- -->, [RouteConfOfRedirect](./brick-types.routeconfofredirect.md)
+

package/dist/brick-types.routeconfofbricks.analyticsdata.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.routeconfofbricks.analyticsdata
+title: RouteConfOfBricks.analyticsData
+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-types](./brick-types.md) &gt; [RouteConfOfBricks](./brick-types.routeconfofbricks.md) &gt; [analyticsData](./brick-types.routeconfofbricks.analyticsdata.md)
+
+## RouteConfOfBricks.analyticsData property
+
+分析数据。
+
+**Signature:**
+
+```typescript
+analyticsData?: Record<string, unknown> | string;
+```
+

package/dist/brick-types.routeconfofbricks.bricks.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.routeconfofbricks.bricks
+title: RouteConfOfBricks.bricks
+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-types](./brick-types.md) &gt; [RouteConfOfBricks](./brick-types.routeconfofbricks.md) &gt; [bricks](./brick-types.routeconfofbricks.bricks.md)
+
+## RouteConfOfBricks.bricks property
+
+构件列表。
+
+**Signature:**
+
+```typescript
+bricks: BrickConf[];
+```
+
+**Reference:** [BrickConf](./brick-types.brickconf.md)
+

package/dist/brick-types.routeconfofbricks.md

@@ -0,0 +1,31 @@
+---
+id: brick-types.routeconfofbricks
+title: RouteConfOfBricks
+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-types](./brick-types.md) &gt; [RouteConfOfBricks](./brick-types.routeconfofbricks.md)
+
+## RouteConfOfBricks interface
+
+包含一组构件的路由配置。
+
+**Signature:**
+
+```typescript
+export interface RouteConfOfBricks extends BaseRouteConf
+```
+
+**Extends:** [BaseRouteConf](./brick-types.baserouteconf.md)
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [analyticsData](./brick-types.routeconfofbricks.analyticsdata.md) | Record&lt;string, unknown&gt; \| string | 分析数据。 |
+|  [bricks](./brick-types.routeconfofbricks.bricks.md) | [BrickConf](./brick-types.brickconf.md)<!-- -->\[\] | 构件列表。 |
+|  [type](./brick-types.routeconfofbricks.type.md) | "bricks" |  |
+

package/dist/brick-types.routeconfofbricks.type.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.routeconfofbricks.type
+title: RouteConfOfBricks.type
+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-types](./brick-types.md) &gt; [RouteConfOfBricks](./brick-types.routeconfofbricks.md) &gt; [type](./brick-types.routeconfofbricks.type.md)
+
+## RouteConfOfBricks.type property
+
+**Signature:**
+
+```typescript
+type?: "bricks";
+```
+