@empathyco/x-components/docs/API-reference/api/x-components.getgetterpath.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [getGetterPath](./x-components.getgetterpath.md)

## getGetterPath() function

Generates a getter path string with the module and getter name.

**Signature:**

```typescript
export declare function getGetterPath<ModuleName extends XModuleName>(moduleName: ModuleName, getterName: keyof ExtractGetters<ModuleName>): string;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

moduleName


</td><td>

ModuleName


</td><td>

The module name the getter belongs to.


</td></tr>
<tr><td>

getterName


</td><td>

keyof [ExtractGetters](./x-components.extractgetters.md)<!-- -->&lt;ModuleName&gt;


</td><td>

The getter name.


</td></tr>
</tbody></table>

**Returns:**

string

A string representing the getter path.