API reference › @evolu/common › Type › ObjectError

Defined in: packages/common/src/Type.ts:12271

An error returned while validating an object and its properties.

Declare required properties as required keys and optional properties as optional keys. Object adds its structural property errors automatically, so each value is only the error returned by that property's Type. The interface can be extended by recursive error declarations.

Extends

Properties

reason

readonly reason:
  | {
  kind: "NotObject";
  value: unknown;
}
  | {
  kind: "UnexpectedPrototype";
  value: object;
}
  | {
  errors: Partial<ObjectStructuralPropertyErrors<Errors>> & [RestError] extends [never] ? unknown : Readonly<Record<PropertyKey,
     | RestError
     | Exclude<ObjectStructuralPropertyErrors<Errors>[keyof Errors], undefined>
    | undefined>>;
  kind: "Properties";
};

Defined in: packages/common/src/Type.ts:12277

type

readonly type: "Object";

Defined in: packages/common/src/Type.ts:893

Inherited from

TypeError.type

Markdown for LLMs