@next-core/next-docs 1.2.561 → 1.2.562

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

@@ -1,21 +0,0 @@
----
-id: brick-types.pluginruntimecontext.event
-title: PluginRuntimeContext.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-types](./brick-types.md) &gt; [PluginRuntimeContext](./brick-types.pluginruntimecontext.md) &gt; [event](./brick-types.pluginruntimecontext.event.md)
-
-## PluginRuntimeContext.event property
-
-当前的在事件处理中的事件对象。
-
-**Signature:**
-
-```typescript
-event?: CustomEvent;
-```
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.pluginruntimecontext.flags
-title: PluginRuntimeContext.flags
-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; [flags](./brick-types.pluginruntimecontext.flags.md)
-
-## PluginRuntimeContext.flags property
-
-特性开关字典。
-
-**Signature:**
-
-```typescript
-flags?: FeatureFlags;
-```
-
-**Reference:** [FeatureFlags](./brick-types.featureflags.md)
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.pluginruntimecontext.hash
-title: PluginRuntimeContext.hash
-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; [hash](./brick-types.pluginruntimecontext.hash.md)
-
-## PluginRuntimeContext.hash property
-
-当前的 hash 参数
-
-**Signature:**
-
-```typescript
-hash?: string;
-```
-

package/dist/brick-types.pluginruntimecontext.md

@@ -1,36 +0,0 @@
----
-id: brick-types.pluginruntimecontext
-title: PluginRuntimeContext
-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)
-
-## PluginRuntimeContext interface
-
-系统运行时信息。
-
-**Signature:**
-
-```typescript
-export interface PluginRuntimeContext
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [app](./brick-types.pluginruntimecontext.app.md) | [MicroApp](./brick-types.microapp.md) | 当前的应用信息。 |
-|  [appendI18nNamespace](./brick-types.pluginruntimecontext.appendi18nnamespace.md) | string | 扩展当前表达式的国际化命名空间。 |
-|  [event](./brick-types.pluginruntimecontext.event.md) | CustomEvent | 当前的在事件处理中的事件对象。 |
-|  [flags](./brick-types.pluginruntimecontext.flags.md) | [FeatureFlags](./brick-types.featureflags.md) | 特性开关字典。 |
-|  [hash](./brick-types.pluginruntimecontext.hash.md) | string | 当前的 hash 参数 |
-|  [overrideApp](./brick-types.pluginruntimecontext.overrideapp.md) | [MicroApp](./brick-types.microapp.md) | 用于跨应用菜单注入等场景的应用重载。 |
-|  [pathname](./brick-types.pluginruntimecontext.pathname.md) | string | 当前的 pathname 参数 |
-|  [query](./brick-types.pluginruntimecontext.query.md) | URLSearchParams | 当前的 query 参数。 |
-|  [segues](./brick-types.pluginruntimecontext.segues.md) | [SeguesConf](./brick-types.seguesconf.md) | 当前应用的页面切换配置。 |
-|  [sys](./brick-types.pluginruntimecontext.sys.md) | [SystemInfo](./brick-types.systeminfo.md) | 系统会话信息。 |
-

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

@@ -1,23 +0,0 @@
----
-id: brick-types.pluginruntimecontext.overrideapp
-title: PluginRuntimeContext.overrideApp
-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; [overrideApp](./brick-types.pluginruntimecontext.overrideapp.md)
-
-## PluginRuntimeContext.overrideApp property
-
-用于跨应用菜单注入等场景的应用重载。
-
-**Signature:**
-
-```typescript
-overrideApp?: MicroApp;
-```
-
-**Reference:** [MicroApp](./brick-types.microapp.md)
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.pluginruntimecontext.pathname
-title: PluginRuntimeContext.pathname
-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; [pathname](./brick-types.pluginruntimecontext.pathname.md)
-
-## PluginRuntimeContext.pathname property
-
-当前的 pathname 参数
-
-**Signature:**
-
-```typescript
-pathname?: string;
-```
-

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

@@ -1,21 +0,0 @@
----
-id: brick-types.pluginruntimecontext.query
-title: PluginRuntimeContext.query
-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; [query](./brick-types.pluginruntimecontext.query.md)
-
-## PluginRuntimeContext.query property
-
-当前的 query 参数。
-
-**Signature:**
-
-```typescript
-query?: URLSearchParams;
-```
-

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

@@ -1,23 +0,0 @@
----
-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

@@ -1,23 +0,0 @@
----
-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

@@ -1,23 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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

@@ -1,23 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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

@@ -1,34 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,30 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,25 +0,0 @@
----
-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

@@ -1,23 +0,0 @@
----
-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

@@ -1,28 +0,0 @@
----
-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" |  |
-