Documentation / @facturometro/einvoice / CustomRuleMetadata

Interface: CustomRuleMetadata

Defined in: packages/validator/src/engine/rule.ts:174

The metadata a custom rule supplies inline; a specification rule reads it from the spec table.

Example

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

const metadata: CustomRuleMetadata = { message: 'A PO number is required.', severity: 'fatal' };

Properties

bt?

readonly optional bt?: readonly string[]

Defined in: packages/validator/src/engine/rule.ts:176

Business terms the rule is about; none by default.

---

docsUrl?

readonly optional docsUrl?: string

Defined in: packages/validator/src/engine/rule.ts:178

Documentation page of the rule.

---

family?

readonly optional family?: string

Defined in: packages/validator/src/engine/rule.ts:180

Rule family; custom by default.

---

message

readonly message: string

Defined in: packages/validator/src/engine/rule.ts:182

Message reported on failure.

---

severity

readonly severity: Severity

Defined in: packages/validator/src/engine/rule.ts:184

Whether a failure makes the document invalid.