@empathyco/x-components
Version:
Empathy X Components
89 lines (41 loc) • 1.5 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [getStateAndGettersFromModule](./x-components.getstateandgettersfrommodule.md)
## getStateAndGettersFromModule() function
Returns an object with the getters and state of a module of store defined by the moduleName parameter.
**Signature:**
```typescript
export declare function getStateAndGettersFromModule<ModuleName extends XModuleName>(state: RootXStoreState, getters: Dictionary, moduleName: ModuleName): StoreModuleStateAndGetters<ModuleName>;
```
## Parameters
<table><thead><tr><th>
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
state
</td><td>
[RootXStoreState](./x-components.rootxstorestate.md)
</td><td>
The Vuex store State.
</td></tr>
<tr><td>
getters
</td><td>
Dictionary
</td><td>
The Vuex store Getters.
</td></tr>
<tr><td>
moduleName
</td><td>
ModuleName
</td><td>
The [XModuleName](./x-components.xmodulename.md) of the module.
</td></tr>
</tbody></table>
**Returns:**
[StoreModuleStateAndGetters](./x-components.storemodulestateandgetters.md)<!-- --><ModuleName>
The [StoreModuleStateAndGetters](./x-components.storemodulestateandgetters.md) with the Getters and the State of the [Store Module](./x-components.xstoremodule.md) defined by moduleName.