<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [assertXPluginOptionsAreValid](./x-components.assertxpluginoptionsarevalid.md)

## assertXPluginOptionsAreValid() function

Asserts that the passed options object is valid, providing helpful error messages.

**Signature:**

```typescript
export declare function assertXPluginOptionsAreValid(options: XPluginOptions | undefined): asserts options is XPluginOptions;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

options


</td><td>

[XPluginOptions](./x-components.xpluginoptions.md) \| undefined


</td><td>

The options to check if they are valid.


</td></tr>
</tbody></table>

**Returns:**

asserts options is [XPluginOptions](./x-components.xpluginoptions.md)

