@next-core/next-docs 1.2.561 → 1.2.562

package/dist/brick-types.baseentityresolveconf.name.md

@@ -1,26 +0,0 @@
----
-id: brick-types.baseentityresolveconf.name
-title: BaseEntityResolveConf.name
-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; [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md) &gt; [name](./brick-types.baseentityresolveconf.name.md)
-
-## BaseEntityResolveConf.name property
-
-> Warning: This API is now obsolete.
-> 
-> 建议统一使用 `transform`<!-- -->。
-> 
-
-将数据源直接赋值给指定的这个属性。
-
-**Signature:**
-
-```typescript
-name?: string;
-```
-

package/dist/brick-types.baseentityresolveconf.onreject.md

@@ -1,23 +0,0 @@
----
-id: brick-types.baseentityresolveconf.onreject
-title: BaseEntityResolveConf.onReject
-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; [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md) &gt; [onReject](./brick-types.baseentityresolveconf.onreject.md)
-
-## BaseEntityResolveConf.onReject property
-
-当异步数据处理抛出错误时，使用该错误对象作为数据源进行转换来作为最终结果。
-
-**Signature:**
-
-```typescript
-onReject?: HandleReject;
-```
-
-**Reference:** [HandleReject](./brick-types.handlereject.md)
-

package/dist/brick-types.baseentityresolveconf.transform.md

@@ -1,23 +0,0 @@
----
-id: brick-types.baseentityresolveconf.transform
-title: BaseEntityResolveConf.transform
-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; [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md) &gt; [transform](./brick-types.baseentityresolveconf.transform.md)
-
-## BaseEntityResolveConf.transform property
-
-数据转换配置。
-
-**Signature:**
-
-```typescript
-transform?: GeneralTransform;
-```
-
-**Reference:** [GeneralTransform](./brick-types.generaltransform.md)
-

package/dist/brick-types.baseentityresolveconf.transformfrom.md

@@ -1,21 +0,0 @@
----
-id: brick-types.baseentityresolveconf.transformfrom
-title: BaseEntityResolveConf.transformFrom
-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; [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md) &gt; [transformFrom](./brick-types.baseentityresolveconf.transformfrom.md)
-
-## BaseEntityResolveConf.transformFrom property
-
-使用返回数据的指定字段作为数据源。
-
-**Signature:**
-
-```typescript
-transformFrom?: string | string[];
-```
-

package/dist/brick-types.baseentityresolveconf.transformmaparray.md

@@ -1,21 +0,0 @@
----
-id: brick-types.baseentityresolveconf.transformmaparray
-title: BaseEntityResolveConf.transformMapArray
-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; [BaseEntityResolveConf](./brick-types.baseentityresolveconf.md) &gt; [transformMapArray](./brick-types.baseentityresolveconf.transformmaparray.md)
-
-## BaseEntityResolveConf.transformMapArray property
-
-设置在数据转换中对数组的映射处理模式。
-
-**Signature:**
-
-```typescript
-transformMapArray?: boolean | "auto";
-```
-

package/dist/brick-types.baserouteconf.alias.md

@@ -1,21 +0,0 @@
----
-id: brick-types.baserouteconf.alias
-title: BaseRouteConf.alias
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [alias](./brick-types.baserouteconf.alias.md)
-
-## BaseRouteConf.alias property
-
-路由别名，它同时有路由唯一 ID 的作用，应保障在微应用内的唯一性。
-
-**Signature:**
-
-```typescript
-alias?: string;
-```
-

package/dist/brick-types.baserouteconf.context.md

@@ -1,23 +0,0 @@
----
-id: brick-types.baserouteconf.context
-title: BaseRouteConf.context
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [context](./brick-types.baserouteconf.context.md)
-
-## BaseRouteConf.context property
-
-上下文配置列表。
-
-**Signature:**
-
-```typescript
-context?: ContextConf[];
-```
-
-**Reference:** [ContextConf](./brick-types.contextconf.md)
-

package/dist/brick-types.baserouteconf.defineresolves.md

@@ -1,23 +0,0 @@
----
-id: brick-types.baserouteconf.defineresolves
-title: BaseRouteConf.defineResolves
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [defineResolves](./brick-types.baserouteconf.defineresolves.md)
-
-## BaseRouteConf.defineResolves property
-
-预定义的异步数据处理配置列表。
-
-**Signature:**
-
-```typescript
-defineResolves?: DefineResolveConf[];
-```
-
-**Reference:** [DefineResolveConf](./brick-types.defineresolveconf.md)
-

package/dist/brick-types.baserouteconf.documentid.md

@@ -1,21 +0,0 @@
----
-id: brick-types.baserouteconf.documentid
-title: BaseRouteConf.documentId
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [documentId](./brick-types.baserouteconf.documentid.md)
-
-## BaseRouteConf.documentId property
-
-关联的文档 ID。
-
-**Signature:**
-
-```typescript
-documentId?: string;
-```
-

package/dist/brick-types.baserouteconf.exact.md

@@ -1,21 +0,0 @@
----
-id: brick-types.baserouteconf.exact
-title: BaseRouteConf.exact
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [exact](./brick-types.baserouteconf.exact.md)
-
-## BaseRouteConf.exact property
-
-是否精确匹配（未设置时系统默认会匹配路由地址及其所有子目录地址）。
-
-**Signature:**
-
-```typescript
-exact?: boolean;
-```
-

package/dist/brick-types.baserouteconf.hybrid.md

@@ -1,21 +0,0 @@
----
-id: brick-types.baserouteconf.hybrid
-title: BaseRouteConf.hybrid
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [hybrid](./brick-types.baserouteconf.hybrid.md)
-
-## BaseRouteConf.hybrid property
-
-标记为混合的路由，将转换 `legacy: iframe` 模式。例如对于标记了 `legacy: iframe` 的应用， 其中 `hybrid: true` 的路由将使用普通模式渲染页面；而对于其它应用，其中 `hybrid: true` 的路由将使用 iframe 模式渲染页面。
-
-**Signature:**
-
-```typescript
-hybrid?: boolean;
-```
-

package/dist/brick-types.baserouteconf.if.md

@@ -1,21 +0,0 @@
----
-id: brick-types.baserouteconf.if
-title: BaseRouteConf.if
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [if](./brick-types.baserouteconf.if.md)
-
-## BaseRouteConf.if property
-
-条件配置，根据 `if` 的计算结果来决定是否展示路由
-
-**Signature:**
-
-```typescript
-if?: string | boolean;
-```
-

package/dist/brick-types.baserouteconf.iid.md

@@ -1,21 +0,0 @@
----
-id: brick-types.baserouteconf.iid
-title: BaseRouteConf.iid
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [iid](./brick-types.baserouteconf.iid.md)
-
-## BaseRouteConf.iid property
-
-构件编排 ID
-
-**Signature:**
-
-```typescript
-iid?: string;
-```
-

package/dist/brick-types.baserouteconf.md

@@ -1,41 +0,0 @@
----
-id: brick-types.baserouteconf
-title: BaseRouteConf
-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; [BaseRouteConf](./brick-types.baserouteconf.md)
-
-## BaseRouteConf interface
-
-路由的基本配置信息。
-
-**Signature:**
-
-```typescript
-export interface BaseRouteConf
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [alias](./brick-types.baserouteconf.alias.md) | string | 路由别名，它同时有路由唯一 ID 的作用，应保障在微应用内的唯一性。 |
-|  [context](./brick-types.baserouteconf.context.md) | [ContextConf](./brick-types.contextconf.md)<!-- -->\[\] | 上下文配置列表。 |
-|  [defineResolves](./brick-types.baserouteconf.defineresolves.md) | [DefineResolveConf](./brick-types.defineresolveconf.md)<!-- -->\[\] | 预定义的异步数据处理配置列表。 |
-|  [documentId](./brick-types.baserouteconf.documentid.md) | string | 关联的文档 ID。 |
-|  [exact](./brick-types.baserouteconf.exact.md) | boolean | 是否精确匹配（未设置时系统默认会匹配路由地址及其所有子目录地址）。 |
-|  [hybrid](./brick-types.baserouteconf.hybrid.md) | boolean | 标记为混合的路由，将转换 <code>legacy: iframe</code> 模式。例如对于标记了 <code>legacy: iframe</code> 的应用， 其中 <code>hybrid: true</code> 的路由将使用普通模式渲染页面；而对于其它应用，其中 <code>hybrid: true</code> 的路由将使用 iframe 模式渲染页面。 |
-|  [if](./brick-types.baserouteconf.if.md) | string \| boolean | 条件配置，根据 <code>if</code> 的计算结果来决定是否展示路由 |
-|  [iid](./brick-types.baserouteconf.iid.md) | string | 构件编排 ID |
-|  [menu](./brick-types.baserouteconf.menu.md) | [MenuConf](./brick-types.menuconf.md) | 菜单配置。 |
-|  [path](./brick-types.baserouteconf.path.md) | string | 路由地址，通常应使用 <code>${APP.homepage}</code> 开头。 |
-|  [permissionsPreCheck](./brick-types.baserouteconf.permissionsprecheck.md) | string\[\] | 预校验的动态权限列表，在编排中可以通过 <code>&lt;% PERMISSIONS.check(&quot;your-action&quot;) %&gt;</code>来校验权限点。 当被校验的权限点为已知字符串，则框架会扫描收集统一校验，不需要在此处声明； 当被校验的权限点需要动态获得，例如通过 <code>QUERY</code>,<code>PATH</code>,<code>CTX</code> 等参数动态计算得到，则需要在 <code>permissionsPreCheck</code> 中提前声明。 如果某个权限点需要在接口中获得，也只需要在 Context 中通过异步 Resolve 提前赋值给 Context 即可。 |
-|  [providers](./brick-types.baserouteconf.providers.md) | [ProviderConf](./brick-types.providerconf.md)<!-- -->\[\] | 提前声明可供路由内使用的 Provider 列表。 |
-|  [public](./brick-types.baserouteconf.public.md) | boolean | 标记为公开的路由不需要登录就能进入。 |
-|  [redirect](./brick-types.baserouteconf.redirect.md) | string \| [ResolveConf](./brick-types.resolveconf.md) | 要重定向的地址或异步处理配置。 |
-|  [segues](./brick-types.baserouteconf.segues.md) | [SeguesConf](./brick-types.seguesconf.md) | 页面切换配置表。 |
-

package/dist/brick-types.baserouteconf.menu.md

@@ -1,23 +0,0 @@
----
-id: brick-types.baserouteconf.menu
-title: BaseRouteConf.menu
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [menu](./brick-types.baserouteconf.menu.md)
-
-## BaseRouteConf.menu property
-
-菜单配置。
-
-**Signature:**
-
-```typescript
-menu?: MenuConf;
-```
-
-**Reference:** [MenuConf](./brick-types.menuconf.md)
-

package/dist/brick-types.baserouteconf.path.md

@@ -1,21 +0,0 @@
----
-id: brick-types.baserouteconf.path
-title: BaseRouteConf.path
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [path](./brick-types.baserouteconf.path.md)
-
-## BaseRouteConf.path property
-
-路由地址，通常应使用 `${APP.homepage}` 开头。
-
-**Signature:**
-
-```typescript
-path: string;
-```
-

package/dist/brick-types.baserouteconf.permissionsprecheck.md

@@ -1,21 +0,0 @@
----
-id: brick-types.baserouteconf.permissionsprecheck
-title: BaseRouteConf.permissionsPreCheck
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [permissionsPreCheck](./brick-types.baserouteconf.permissionsprecheck.md)
-
-## BaseRouteConf.permissionsPreCheck property
-
-预校验的动态权限列表，在编排中可以通过 `<% PERMISSIONS.check("your-action") %>`<!-- -->来校验权限点。 当被校验的权限点为已知字符串，则框架会扫描收集统一校验，不需要在此处声明； 当被校验的权限点需要动态获得，例如通过 `QUERY`<!-- -->,`PATH`<!-- -->,`CTX` 等参数动态计算得到，则需要在 `permissionsPreCheck` 中提前声明。 如果某个权限点需要在接口中获得，也只需要在 Context 中通过异步 Resolve 提前赋值给 Context 即可。
-
-**Signature:**
-
-```typescript
-permissionsPreCheck?: string[];
-```
-

package/dist/brick-types.baserouteconf.providers.md

@@ -1,27 +0,0 @@
----
-id: brick-types.baserouteconf.providers
-title: BaseRouteConf.providers
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [providers](./brick-types.baserouteconf.providers.md)
-
-## BaseRouteConf.providers property
-
-提前声明可供路由内使用的 Provider 列表。
-
-**Signature:**
-
-```typescript
-providers?: ProviderConf[];
-```
-
-**Reference:** [ProviderConf](./brick-types.providerconf.md)
-
-## Remarks
-
-推荐优先使用 `useProvider` 而无须提前声明 `providers`<!-- -->。
-

package/dist/brick-types.baserouteconf.public.md

@@ -1,21 +0,0 @@
----
-id: brick-types.baserouteconf.public
-title: BaseRouteConf.public
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [public](./brick-types.baserouteconf.public.md)
-
-## BaseRouteConf.public property
-
-标记为公开的路由不需要登录就能进入。
-
-**Signature:**
-
-```typescript
-public?: boolean;
-```
-

package/dist/brick-types.baserouteconf.redirect.md

@@ -1,23 +0,0 @@
----
-id: brick-types.baserouteconf.redirect
-title: BaseRouteConf.redirect
-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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [redirect](./brick-types.baserouteconf.redirect.md)
-
-## BaseRouteConf.redirect property
-
-要重定向的地址或异步处理配置。
-
-**Signature:**
-
-```typescript
-redirect?: string | ResolveConf;
-```
-
-**Reference:** [ResolveConf](./brick-types.resolveconf.md)
-

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

@@ -1,27 +0,0 @@
----
-id: brick-types.baserouteconf.segues
-title: BaseRouteConf.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; [BaseRouteConf](./brick-types.baserouteconf.md) &gt; [segues](./brick-types.baserouteconf.segues.md)
-
-## BaseRouteConf.segues property
-
-页面切换配置表。
-
-**Signature:**
-
-```typescript
-segues?: SeguesConf;
-```
-
-**Reference:** [SeguesConf](./brick-types.seguesconf.md)
-
-## Remarks
-
-可以用于组织视图之间的访问关系。在 Next Builder 中可以在 Routes Graph 页面显示该关系。
-

package/dist/brick-types.batchupdatecontextitem.md

@@ -1,28 +0,0 @@
----
-id: brick-types.batchupdatecontextitem
-title: BatchUpdateContextItem
-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; [BatchUpdateContextItem](./brick-types.batchupdatecontextitem.md)
-
-## BatchUpdateContextItem interface
-
-批量更新子项
-
-**Signature:**
-
-```typescript
-export interface BatchUpdateContextItem
-```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [name](./brick-types.batchupdatecontextitem.name.md) | string |  |
-|  [value](./brick-types.batchupdatecontextitem.value.md) | unknown |  |
-

package/dist/brick-types.batchupdatecontextitem.name.md

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

package/dist/brick-types.batchupdatecontextitem.value.md

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

package/dist/brick-types.breadcrumbconf.items.md

@@ -1,23 +0,0 @@
----
-id: brick-types.breadcrumbconf.items
-title: BreadcrumbConf.items
-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; [BreadcrumbConf](./brick-types.breadcrumbconf.md) &gt; [items](./brick-types.breadcrumbconf.items.md)
-
-## BreadcrumbConf.items property
-
-面包屑列表。
-
-**Signature:**
-
-```typescript
-items: BreadcrumbItemConf[];
-```
-
-**Reference:** [BreadcrumbItemConf](./brick-types.breadcrumbitemconf.md)
-