---
id: "packages/active-grid/api/grid-configuration-error"
title: "Grid configuration error"
description: "GridConfigurationError, GridConfigurationErrorCode, GridConfigurationErrorOptions: generated from the source of active-grid."
url: "/packages/active-grid/api/grid-configuration-error"
locale: "en"
revision: "g0mvjxwj5c-88bdbe1c:grid-configuration-error"
---

# Grid configuration error

Exported by `@workspace/active-grid`. Generated from the package source; part of [the index of every export](/packages/active-grid/api).

## Functions, hooks and constants

**GridConfigurationError**

```ts
class GridConfigurationError extends Error {
  readonly code: GridConfigurationErrorCode;
  readonly field: string;
  readonly constraint: string;
  readonly value: unknown;
  constructor({ code, field, constraint, value, message, }: GridConfigurationErrorOptions);
}
```

A grid configuration the grid cannot run with.

## Types

**GridConfigurationErrorCode**

```ts
type GridConfigurationErrorCode =
  | 'GRID_ROW_ID_MISSING'
  | 'GRID_SERVER_OPTIONS_INVALID'
  | 'GRID_DIRECTION_INVALID';
```

The closed set of configuration mistakes the grid refuses.

**GridConfigurationErrorOptions**

```ts
interface GridConfigurationErrorOptions {
  code: GridConfigurationErrorCode;
  field: string;
  constraint: string;
  value?: unknown;
  message: string;
}
```
