Documentation / @facturometro/validator / FailureRefinement

Interface: FailureRefinement

Defined in: packages/validator/src/engine/context.ts:102

Where a failure is and what explains it; see RuleContext.fail.

Example

import type { FailureRefinement } from '@facturometro/validator';

const refinement: FailureRefinement = { at: ['payableAmount'], data: { expected: '1.00' } };

Properties

at?

readonly optional at?: ModelPath

Defined in: packages/validator/src/engine/context.ts:104

Model path of the offending element, relative to the context node.

---

data?

readonly optional data?: Readonly<Record<string, string>>

Defined in: packages/validator/src/engine/context.ts:106

Values that explain the failure.