Interface
The extension interface for BuilderOperations extension point.
Properties
| Property | Type | Notes |
|---|---|---|
(appConfig: IMAppConfig) => Promise<string> | Will be invoked before publish app. All extensions must return the updated app config, the updated app config will be used by the next extension. | |
(appConfig: IMAppConfig) => Promise<IMAppConfig> | Will be invoked before save app. A widget can use this method to check or update the config before saving the app. All extensions must return the updated app config, the updated app config will be used by the next extension. | |
idinherited | string | The unique ID. For widget's provided extension, the id pattern is: widgetId + extensionName |
indexinherited | number | If an extension point supports multiple extensions, the index is used to determine the extension order. |
labelinherited | string | The extension label. |
nameinherited | string | The extension name. |
widgetIdinherited | string | The widget ID that provides the extension. No widget id means the extension is provided by Jimu. |
beforePublish
Interface PropertybeforePublish: (appConfig: IMAppConfig) => Promise<string>Will be invoked before publish app. All extensions must return the updated app config, the updated app config will be used by the next extension.
Type declaration
function(appConfig: IMAppConfig): Promise<string>Parameters
| Parameter | Type | Notes |
|---|---|---|
app | IMAppConfig | The app config to be published. |
Returns
Promise<string>beforeSave
Interface PropertybeforeSave: (appConfig: IMAppConfig) => Promise<IMAppConfig>Will be invoked before save app. A widget can use this method to check or update the config before saving the app. All extensions must return the updated app config, the updated app config will be used by the next extension.
Type declaration
function(appConfig: IMAppConfig): Promise<IMAppConfig>Parameters
| Parameter | Type | Notes |
|---|---|---|
app | IMAppConfig | The app config to be saved. |
Returns
Promise<IMAppConfig>id
id: stringThe unique ID. For widget's provided extension, the id pattern is: widgetId + extensionName
index
index: numberIf an extension point supports multiple extensions, the index is used to determine the extension order.
widgetId
widgetId: stringThe widget ID that provides the extension. No widget id means the extension is provided by Jimu.