@empathyco/x-components
Version:
Empathy X Components
57 lines (27 loc) • 934 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [isHierarchicalFacet](./x-types.ishierarchicalfacet.md)
## isHierarchicalFacet() function
Type guard to check if a facet is an [HierarchicalFacet](./x-types.hierarchicalfacet.md)<!-- -->.
**Signature:**
```typescript
export declare function isHierarchicalFacet(facet: Facet): facet is HierarchicalFacet;
```
## Parameters
<table><thead><tr><th>
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
facet
</td><td>
[Facet](./x-types.facet.md)
</td><td>
The facet to check.
</td></tr>
</tbody></table>
**Returns:**
facet is [HierarchicalFacet](./x-types.hierarchicalfacet.md)
True if the facet is a [HierarchicalFacet](./x-types.hierarchicalfacet.md)<!-- -->, false otherwise.