TextRuleOptions

Defined in: packages/ddd-core/domain/rules/text.rule.ts:7

Options of textRule.

Properties

error?

readonly optional error?: ValueViolationError

Defined in: packages/ddd-core/domain/rules/text.rule.ts:40

Builds the error thrown for a violation. Defaults to InvalidValueException.

---

field

readonly field: string

Defined in: packages/ddd-core/domain/rules/text.rule.ts:9

Field name reported in the violation and in the default message.

---

maxLength?

readonly optional maxLength?: number

Defined in: packages/ddd-core/domain/rules/text.rule.ts:25

Most characters after normalization, counted like minLength. A column limit counted in code points, such as varchar(n), is never exceeded by a value within it.

---

minLength?

readonly optional minLength?: number

Defined in: packages/ddd-core/domain/rules/text.rule.ts:19

Fewest characters after normalization, counted in UTF-16 code units like String.length and Zod’s .min().

---

multiline?

readonly optional multiline?: boolean

Defined in: packages/ddd-core/domain/rules/text.rule.ts:35

true accepts tab, line feed and carriage return inside the text. Defaults to false: they are a characters violation.

---

pattern?

readonly optional pattern?: RegExp

Defined in: packages/ddd-core/domain/rules/text.rule.ts:30

Pattern the normalized text must match. A g or y flag is rejected, because test() would then depend on the previous call.

---

required?

readonly optional required?: boolean

Defined in: packages/ddd-core/domain/rules/text.rule.ts:14

false accepts null, undefined and blank text, and normalizes them to null. Defaults to true: they are a required violation.