ReduxStoreExtension
Interface
The extension interface for ReduxStore extension point.
Properties
| Property | Type | Notes |
|---|---|---|
string | The unique id. For widget's provided extension, the id pattern is: widgetId + extensionName | |
number | If an extension point supports multiple extensions, the index is used to determine the extension order. | |
string | The extension name. | |
string | The widget id that provides the extension. No widget id means the extension is provided by Jimu. |
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 |
|---|---|---|
string[] | The method that returns the redux actions. | |
any | The method that returns the redux initial store state. | |
(localState: any, action: any, state: IMState) => any | The method that returns the redux reducer. The reducer should return local state. | |
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
id: stringThe unique id. For widget's provided extension, the id pattern is: widgetId + extensionName