@empathyco/x-components/docs/API-reference/api/x-components.assertxpluginoptionsarevalid.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; [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

|  Parameter | Type | Description |
|  --- | --- | --- |
|  options | [XPluginOptions](./x-components.xpluginoptions.md) \| undefined | The options to check if they are valid. |

**Returns:**

asserts options is [XPluginOptions](./x-components.xpluginoptions.md)