tryError API Documentation v0.0.1-alpha.1

---

tryError API Documentation / validationError

Function: validationError()

function validationError<T>(field, code, message, context?): ValidationError<T>;

Defined in: factories.ts:615

IMPROVED: More intuitive validation error factory

Common usage pattern with field and message as primary parameters

Type Parameters

T

T extends string = "ValidationError"

Parameters

field

string

code

string

message

string

context?

Record<string, unknown>

Returns

ValidationError<T>

Example

const error = validationError(
  "email",
  "invalid",
  "Must be a valid email address",
  {
    value: "invalid-email",
    pattern: /^\S+@\S+\.\S+$/,
  }
);