Interface
The extension interface for ReduxStore extension point.
Properties
| Property | Type | 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. | |
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. |
nameinherited | string | The extension name. |
widgetIdinherited | string | The widget id that provides the extension. No widget id means the extension is provided by Jimu. |
getActions
Interface PropertygetActions: () => string[]The method that returns the redux actions.
Type declaration
function(): string[]Returns
string[]getInitLocalState
Interface PropertygetInitLocalState: () => anyThe method that returns the redux initial store state.
Type declaration
function(): anyReturns
anygetReducer
Interface PropertygetReducer: () => (localState: any, action: any, state: IMState) => anyThe method that returns the redux reducer. The reducer should return local state.
Type declaration
function(): (localState: any, action: any, state: IMState) => anyReturns
(localState: any, action: any, state: IMState) => anyfunction(localState: any, action: any, state: IMState): anyParameters
| Parameter | Type |
|---|---|
local | any |
action | any |
state | IMState |
Returns
anygetStoreKey
Interface PropertygetStoreKey: () => stringThe method that returns the redux store key. The key supports this format: a.b.c.
Type declaration
function(): stringReturns
stringid
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.