@next-core/next-docs 1.2.555 → 1.2.556

package/dist/brick-types.transformedfunction.globals.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.transformedfunction.globals
+title: TransformedFunction.globals
+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; [TransformedFunction](./brick-types.transformedfunction.md) &gt; [globals](./brick-types.transformedfunction.globals.md)
+
+## TransformedFunction.globals property
+
+要访问的全局对象列表
+
+**Signature:**
+
+```typescript
+globals: string[];
+```
+

package/dist/brick-types.transformedfunction.md

@@ -0,0 +1,28 @@
+---
+id: brick-types.transformedfunction
+title: TransformedFunction
+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; [TransformedFunction](./brick-types.transformedfunction.md)
+
+## TransformedFunction interface
+
+编译后的函数
+
+**Signature:**
+
+```typescript
+export interface TransformedFunction
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [globals](./brick-types.transformedfunction.globals.md) | string\[\] | 要访问的全局对象列表 |
+|  [source](./brick-types.transformedfunction.source.md) | string | 编译后的 JS 代码 |
+

package/dist/brick-types.transformedfunction.source.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.transformedfunction.source
+title: TransformedFunction.source
+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; [TransformedFunction](./brick-types.transformedfunction.md) &gt; [source](./brick-types.transformedfunction.source.md)
+
+## TransformedFunction.source property
+
+编译后的 JS 代码
+
+**Signature:**
+
+```typescript
+source: string;
+```
+

package/dist/brick-types.transformitem.from.md

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

package/dist/brick-types.transformitem.maparray.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.transformitem.maparray
+title: TransformItem.mapArray
+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; [TransformItem](./brick-types.transformitem.md) &gt; [mapArray](./brick-types.transformitem.maparray.md)
+
+## TransformItem.mapArray property
+
+**Signature:**
+
+```typescript
+mapArray?: boolean | "auto";
+```
+

package/dist/brick-types.transformitem.md

@@ -0,0 +1,29 @@
+---
+id: brick-types.transformitem
+title: TransformItem
+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; [TransformItem](./brick-types.transformitem.md)
+
+## TransformItem interface
+
+数据转换项。
+
+**Signature:**
+
+```typescript
+export interface TransformItem
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [from](./brick-types.transformitem.from.md) | string \| string\[\] |  |
+|  [mapArray](./brick-types.transformitem.maparray.md) | boolean \| "auto" |  |
+|  [to](./brick-types.transformitem.to.md) | string \| [TransformMap](./brick-types.transformmap.md) |  |
+

package/dist/brick-types.transformitem.to.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.transformitem.to
+title: TransformItem.to
+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; [TransformItem](./brick-types.transformitem.md) &gt; [to](./brick-types.transformitem.to.md)
+
+## TransformItem.to property
+
+**Signature:**
+
+```typescript
+to: string | TransformMap;
+```
+
+**Reference:** [TransformMap](./brick-types.transformmap.md)
+

package/dist/brick-types.transformmap.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.transformmap
+title: TransformMap
+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; [TransformMap](./brick-types.transformmap.md)
+
+## TransformMap interface
+
+数据转换表。
+
+**Signature:**
+
+```typescript
+export interface TransformMap
+```
+

package/dist/brick-types.updateanchorfunction.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.updateanchorfunction
+title: UpdateAnchorFunction
+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; [UpdateAnchorFunction](./brick-types.updateanchorfunction.md)
+
+## UpdateAnchorFunction interface
+
+设置指定的 anchor （URL hash）地址，此方法默认不会触发页面重新渲染。 往浏览器会话历史栈中推入一条新记录。
+
+**Signature:**
+
+```typescript
+export declare type UpdateAnchorFunction = (hash: string, state?: PluginHistoryState, callback?: (blocked: boolean) => void) => void;
+```
+

package/dist/brick-types.updatequeryfunction.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.updatequeryfunction
+title: UpdateQueryFunction
+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; [UpdateQueryFunction](./brick-types.updatequeryfunction.md)
+
+## UpdateQueryFunction interface
+
+更新指定的 query 参数。
+
+**Signature:**
+
+```typescript
+export declare type UpdateQueryFunction = (query: Record<string, unknown>, options?: UpdateQueryOptions, callback?: (blocked: boolean) => void) => void;
+```
+
+**Reference:** [UpdateQueryOptions](./brick-types.updatequeryoptions.md)
+

package/dist/brick-types.updatequeryoptions.clear.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.updatequeryoptions.clear
+title: UpdateQueryOptions.clear
+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; [UpdateQueryOptions](./brick-types.updatequeryoptions.md) &gt; [clear](./brick-types.updatequeryoptions.clear.md)
+
+## UpdateQueryOptions.clear property
+
+是否同时清除当前的所有其它 query 参数。
+
+**Signature:**
+
+```typescript
+clear?: boolean;
+```
+

package/dist/brick-types.updatequeryoptions.extraquery.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.updatequeryoptions.extraquery
+title: UpdateQueryOptions.extraQuery
+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; [UpdateQueryOptions](./brick-types.updatequeryoptions.md) &gt; [extraQuery](./brick-types.updatequeryoptions.extraquery.md)
+
+## UpdateQueryOptions.extraQuery property
+
+额外要更新的 query 参数。
+
+**Signature:**
+
+```typescript
+extraQuery?: Record<string, unknown>;
+```
+

package/dist/brick-types.updatequeryoptions.keephash.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.updatequeryoptions.keephash
+title: UpdateQueryOptions.keepHash
+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; [UpdateQueryOptions](./brick-types.updatequeryoptions.md) &gt; [keepHash](./brick-types.updatequeryoptions.keephash.md)
+
+## UpdateQueryOptions.keepHash property
+
+是否保留当前 hash 参数。
+
+**Signature:**
+
+```typescript
+keepHash?: boolean;
+```
+

package/dist/brick-types.updatequeryoptions.md

@@ -0,0 +1,31 @@
+---
+id: brick-types.updatequeryoptions
+title: UpdateQueryOptions
+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; [UpdateQueryOptions](./brick-types.updatequeryoptions.md)
+
+## UpdateQueryOptions interface
+
+更新 query 参数时的选项
+
+**Signature:**
+
+```typescript
+export interface UpdateQueryOptions extends PluginHistoryState
+```
+
+**Extends:** PluginHistoryState
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [clear](./brick-types.updatequeryoptions.clear.md) | boolean | 是否同时清除当前的所有其它 query 参数。 |
+|  [extraQuery](./brick-types.updatequeryoptions.extraquery.md) | Record&lt;string, unknown&gt; | 额外要更新的 query 参数。 |
+|  [keepHash](./brick-types.updatequeryoptions.keephash.md) | boolean | 是否保留当前 hash 参数。 |
+

package/dist/brick-types.usebackendconf.args.md

@@ -0,0 +1,19 @@
+---
+id: brick-types.usebackendconf.args
+title: UseBackendConf.args
+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; [UseBackendConf](./brick-types.usebackendconf.md) &gt; [args](./brick-types.usebackendconf.args.md)
+
+## UseBackendConf.args property
+
+**Signature:**
+
+```typescript
+args: any[] | ((...args: any[]) => any[]);
+```
+

package/dist/brick-types.usebackendconf.md

@@ -0,0 +1,29 @@
+---
+id: brick-types.usebackendconf
+title: UseBackendConf
+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; [UseBackendConf](./brick-types.usebackendconf.md)
+
+## UseBackendConf interface
+
+在 `useBackend` 中使用provider的配置 \*
+
+**Signature:**
+
+```typescript
+export interface UseBackendConf
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [args](./brick-types.usebackendconf.args.md) | any\[\] \| ((...args: any\[\]) =&gt; any\[\]) |  |
+|  [provider](./brick-types.usebackendconf.provider.md) | string |  |
+|  [transform](./brick-types.usebackendconf.transform.md) | (data: any) =&gt; void |  |
+

package/dist/brick-types.usebackendconf.provider.md

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

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

@@ -0,0 +1,19 @@
+---
+id: brick-types.usebackendconf.transform
+title: UseBackendConf.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; [UseBackendConf](./brick-types.usebackendconf.md) &gt; [transform](./brick-types.usebackendconf.transform.md)
+
+## UseBackendConf.transform property
+
+**Signature:**
+
+```typescript
+transform?: (data: any) => void;
+```
+

package/dist/brick-types.usebrickconf.md

@@ -0,0 +1,23 @@
+---
+id: brick-types.usebrickconf
+title: UseBrickConf
+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; [UseBrickConf](./brick-types.usebrickconf.md)
+
+## UseBrickConf interface
+
+使用 `useBrick` 自行渲染子构件的配置。
+
+**Signature:**
+
+```typescript
+export declare type UseBrickConf = UseSingleBrickConf | UseSingleBrickConf[];
+```
+
+**Reference:** [UseSingleBrickConf](./brick-types.usesinglebrickconf.md)
+

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

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

package/dist/brick-types.usebrickslotconf.md

@@ -0,0 +1,28 @@
+---
+id: brick-types.usebrickslotconf
+title: UseBrickSlotConf
+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; [UseBrickSlotConf](./brick-types.usebrickslotconf.md)
+
+## UseBrickSlotConf interface
+
+在 `useBrick` 中使用的插槽配置。
+
+**Signature:**
+
+```typescript
+export interface UseBrickSlotConf
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [bricks](./brick-types.usebrickslotconf.bricks.md) | [UseSingleBrickConf](./brick-types.usesinglebrickconf.md)<!-- -->\[\] | 子构件列表。 |
+|  [type](./brick-types.usebrickslotconf.type.md) | "bricks" |  |
+

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

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

package/dist/brick-types.usebrickslotsconf.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.usebrickslotsconf
+title: UseBrickSlotsConf
+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; [UseBrickSlotsConf](./brick-types.usebrickslotsconf.md)
+
+## UseBrickSlotsConf interface
+
+在 `useBrick` 中使用的插槽配置表。
+
+**Signature:**
+
+```typescript
+export interface UseBrickSlotsConf
+```
+

package/dist/brick-types.useprovidereventhandler.args.md

@@ -0,0 +1,21 @@
+---
+id: brick-types.useprovidereventhandler.args
+title: UseProviderEventHandler.args
+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; [UseProviderEventHandler](./brick-types.useprovidereventhandler.md) &gt; [args](./brick-types.useprovidereventhandler.args.md)
+
+## UseProviderEventHandler.args property
+
+传递的参数列表
+
+**Signature:**
+
+```typescript
+args?: unknown[];
+```
+

package/dist/brick-types.useprovidereventhandler.callback.md

@@ -0,0 +1,27 @@
+---
+id: brick-types.useprovidereventhandler.callback
+title: UseProviderEventHandler.callback
+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; [UseProviderEventHandler](./brick-types.useprovidereventhandler.md) &gt; [callback](./brick-types.useprovidereventhandler.callback.md)
+
+## UseProviderEventHandler.callback property
+
+事件处理回调。
+
+**Signature:**
+
+```typescript
+callback?: BrickEventHandlerCallback;
+```
+
+**Reference:** [BrickEventHandlerCallback](./brick-types.brickeventhandlercallback.md)
+
+## Remarks
+
+事件处理过程将当做异步函数看待，当成功、失败时分别执行 `success` 和 `error` 动作， 无论成功与否，最终再执行 `finally` 动作。
+

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

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

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

@@ -0,0 +1,21 @@
+---
+id: brick-types.useprovidereventhandler.if
+title: UseProviderEventHandler.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; [UseProviderEventHandler](./brick-types.useprovidereventhandler.md) &gt; [if](./brick-types.useprovidereventhandler.if.md)
+
+## UseProviderEventHandler.if property
+
+根据条件决定是否执行该动作。
+
+**Signature:**
+
+```typescript
+if?: string | boolean;
+```
+

package/dist/brick-types.useprovidereventhandler.md

@@ -0,0 +1,33 @@
+---
+id: brick-types.useprovidereventhandler
+title: UseProviderEventHandler
+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; [UseProviderEventHandler](./brick-types.useprovidereventhandler.md)
+
+## UseProviderEventHandler interface
+
+使用 Provider 构件进行事件处理的配置。
+
+**Signature:**
+
+```typescript
+export interface UseProviderEventHandler
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [args](./brick-types.useprovidereventhandler.args.md) | unknown\[\] | 传递的参数列表 |
+|  [callback](./brick-types.useprovidereventhandler.callback.md) | [BrickEventHandlerCallback](./brick-types.brickeventhandlercallback.md) | 事件处理回调。 |
+|  [else](./brick-types.useprovidereventhandler.else.md) | [BrickEventHandler](./brick-types.brickeventhandler.md) \| [BrickEventHandler](./brick-types.brickeventhandler.md)<!-- -->\[\] | 不满足条件分支 |
+|  [if](./brick-types.useprovidereventhandler.if.md) | string \| boolean | 根据条件决定是否执行该动作。 |
+|  [method](./brick-types.useprovidereventhandler.method.md) | "resolve" \| "saveAs" |  |
+|  [poll](./brick-types.useprovidereventhandler.poll.md) | [ProviderPollOptions](./brick-types.providerpolloptions.md) | 使用 Provider 进行轮询时的选项配置。 |
+|  [useProvider](./brick-types.useprovidereventhandler.useprovider.md) | string | 指定要使用的构件名。 |
+