@empathyco/x-components
Version:
Empathy X Components
73 lines (34 loc) • 1.48 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [wireDispatch](./x-components.wiredispatch.md)
## wireDispatch() function
Creates a wire that dispatch an action to the store. This wire receives a function. This function is used to get the actual payload value passed to action. This wire can be used in every event, as it does not have a payload type associated.
**Signature:**
```typescript
export declare function wireDispatch<Payload>(action: string, payloadFactory: (params: PayloadFactoryData<Payload>) => any): AnyWire;
```
## Parameters
<table><thead><tr><th>
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
action
</td><td>
string
</td><td>
The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`<!-- -->.
</td></tr>
<tr><td>
payloadFactory
</td><td>
(params: [PayloadFactoryData](./x-components.payloadfactorydata.md)<!-- --><Payload>) => any
</td><td>
A function that receives a [object](./x-components.payloadfactorydata.md) with the Store state, getters, payload and metadata as parameter.
</td></tr>
</tbody></table>
**Returns:**
[AnyWire](./x-components.anywire.md)
A [AnyWire](./x-components.anywire.md) wire that dispatches the action with the payload returned by the payloadFactory.