# RateLimitResult

`interface` in `types` · v0.8.0-next.6

<https://docs.seedcord.org/packages/types/0.8.0-next.6/interfaces/rate-limit-result>

The outcome of an [`IRateLimiter`](/packages/types/0.8.0-next.6/interfaces/irate-limiter) `charge` or `peek`.

```ts
interface RateLimitResult
```

## Properties

### limited

```ts
limited: boolean;
```

Whether the key is at or over its limit for the current window.

### remaining

```ts
remaining: number;
```

Slots left in the current window. Exact after a `charge`, advisory on a `peek`.

### resetAt

```ts
resetAt: EpochMs;
```

Absolute epoch milliseconds when the earliest slot frees up, for `<t:...:R>` markup after a divide by 1000. `0` when not limited.

### retryAfterMs

```ts
retryAfterMs: number;
```

Milliseconds until [`resetAt`](/packages/types/0.8.0-next.6/interfaces/rate-limit-result#reset-at). `0` when not limited.