Interface
The extension interface for ReduxStore extension point.
Properties
| Property | Type | Notes |
|---|---|---|
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. |
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.
Methods
| Method | Returns | Notes |
|---|---|---|
getActions() | string[] | The method that returns the redux actions. |
getInitLocalState() | any | The method that returns the redux initial store state. |
getReducer() | (localState: any, action: any, state: IMState) => any | The method that returns the redux reducer. The reducer should return local state. |
getStoreKey() | string | The method that returns the redux store key. The key supports this format: a.b.c. |
getActions
Interface MethodgetActions(): string[]The method that returns the redux actions.
Returns
string[]getInitLocalState
Interface MethodgetInitLocalState(): anyThe method that returns the redux initial store state.
Returns
anygetReducer
Interface MethodgetReducer(): (localState: any, action: any, state: IMState) => anyThe method that returns the redux reducer. The reducer should return local state.
Returns
(localState: any, action: any, state: IMState) => anyfunction(localState: any, action: any, state: IMState): anyParameters
| Parameter | Type |
|---|---|
local | any |
action | any |
state | IMState |
Returns
any