API Reference / @evolu/common / Type / ObjectError
Interface: ObjectError<PropsErrors>
Defined in: packages/common/src/Type.ts:2726
Extends
TypeErrorWithReason<"Object", | {kind:"NotObject"; } | {errors:Partial<PropsErrors>;kind:"Props"; } | {extraKeys:ReadonlyArray<string>;kind:"ExtraKeys"; }>
Type Parameters
| Type Parameter | Default type |
|---|---|
PropsErrors extends Record<string, TypeError> | Record<string, TypeError> |
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
reason | readonly | | { kind: "NotObject"; } | { errors: Partial<PropsErrors>; kind: "Props"; } | { extraKeys: readonly string[]; kind: "ExtraKeys"; } | The detailed reason for the error, represented as a tagged union. | TypeErrorWithReason.reason | packages/common/src/Type.ts:264 |
type | readonly | "Object" | - | TypeErrorWithReason.type | packages/common/src/Type.ts:248 |
value | readonly | unknown | The value that was received and caused the error. Provides additional context for debugging and validation feedback. | TypeErrorWithReason.value | packages/common/src/Type.ts:254 |