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

[Home](./index.md) &gt; [motion-sdk](./motion-sdk.md) &gt; [LimiterError](./motion-sdk.limitererror.md)

## LimiterError class

An error prevented checking or updating the rate limit.

**Signature:**

```typescript
export declare class LimiterError extends Error implements MotionError 
```
**Extends:** Error

**Implements:** [MotionError](./motion-sdk.motionerror.md)

## Remarks

See [isLimiterError()](./motion-sdk.islimitererror.md) for a built-in way to identify [LimiterError](./motion-sdk.limitererror.md) objects.

## Constructors

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

Constructor


</th><th>

Modifiers


</th><th>

Description


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

[(constructor)(limiter, cause, attemptedKey)](./motion-sdk.limitererror._constructor_.md)


</td><td>


</td><td>

Constructs a new instance of the `LimiterError` class


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

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[attemptedKey?](./motion-sdk.limitererror.attemptedkey.md)


</td><td>

`readonly`


</td><td>

string \| number \| undefined


</td><td>

_(Optional)_ The rate limiter key that was attempted.


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

[cause](./motion-sdk.limitererror.cause.md)


</td><td>

`readonly`


</td><td>

unknown


</td><td>

The underlying error from the rate limiter.


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

[errorType](./motion-sdk.limitererror.errortype.md)


</td><td>


</td><td>

typeof [limiterErrorType](./motion-sdk.limitererrortype.md)


</td><td>

Indicates the class of the error.


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

[limiter](./motion-sdk.limitererror.limiter.md)


</td><td>

`readonly`


</td><td>

RateLimiterAbstract


</td><td>

The erroring rate limiter. See [rate-limiter-abstract reference](https://github.com/animir/node-rate-limiter-flexible/wiki)<!-- -->.


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