# GridComponentErrorDetails

Fields, allowed values, and APIs that use GridComponentErrorDetails.

Canonical: https://grid.syidax.com/docs/types/GridComponentErrorDetails/

<a id="definition"></a>

## Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

```typescript
export interface GridComponentErrorDetails {
  readonly code: GridComponentErrorCode;
  readonly phase: GridComponentLifecyclePhase;
  readonly componentKind: GridComponentKind;
  readonly componentName?: string;
  readonly mountKey?: string;
  readonly generation?: number;
  readonly retryable: boolean;
  readonly cause?: unknown;
}
```

<a id="used-by"></a>

## APIs using this type

- [componentError](https://grid.syidax.com/docs/events/componentError.md) — Reports custom component initialization or invocation errors. Handle them by target and phase rather than ignoring them.

<a id="parents"></a>

## Contracts containing this type

- [SyGridEventMap](https://grid.syidax.com/docs/types/SyGridEventMap.md)

<a id="related"></a>

## Related types

- [GridComponentErrorCode](https://grid.syidax.com/docs/types/GridComponentErrorCode.md)
- [GridComponentLifecyclePhase](https://grid.syidax.com/docs/types/GridComponentLifecyclePhase.md)
- [GridComponentKind](https://grid.syidax.com/docs/types/GridComponentKind.md)