UNPKG

@empathyco/x-components

Version:
28 lines (16 loc) 952 B
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [wireCommit](./x-components.wirecommit_1.md) ## wireCommit() function Creates a wire that commits a mutation to the store. This wire can receive any value as payload. This wire can be used in every event, as it does not have a payload type associated. **Signature:** ```typescript export declare function wireCommit(mutation: string, staticPayload: any): AnyWire; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | mutation | string | The full mutation path to commit. I.e. <code>x/searchBox/setQuery</code>. | | staticPayload | any | A static payload to pass to the mutation. | **Returns:** [AnyWire](./x-components.anywire.md) [AnyWire](./x-components.anywire.md) A wire that commits the mutation with the staticPayload payload.