@empathyco/x-components
Version:
Empathy X Components
27 lines (15 loc) • 1.14 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [namespacedThrottle](./x-components.namespacedthrottle.md)
## namespacedThrottle() function
Type safe throttle operator which creates a function which can only access the Module of the [Vuex](https://vuex.vuejs.org/) Store passed as parameter.
**Signature:**
```typescript
export declare function namespacedThrottle<ModuleName extends XModuleName>(moduleName: ModuleName): NamespacedTimeWireOperator<ModuleName>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| moduleName | ModuleName | The [XModuleName](./x-components.xmodulename.md) to create the operator wire. |
**Returns:**
[NamespacedTimeWireOperator](./x-components.namespacedtimewireoperator.md)<!-- --><ModuleName>
A function which creates a wire that uses the [throttle()](./x-components.throttle.md) wire operator to execute the `wire` once every couple of milliseconds. This throttle time is given by the execution of the `timeRetrieving` function.