Documentation / @facturometro/einvoice / Ruleset

Interface: Ruleset

Defined in: packages/validator/src/rulesets/define.ts:117

A ruleset constant: the frozen definition, with defaults filled in. Compose constants in a list to validate against them.

Example

import { dkRuleset, en16931Ruleset, peppolRuleset, validate } from '@facturometro/validator';

validate(invoice, { ruleset: [en16931Ruleset, peppolRuleset, dkRuleset] });
dkRuleset.requires.map((ruleset) => ruleset.id); // ['peppol']

Properties

disable

readonly disable: readonly string[]

Defined in: packages/validator/src/rulesets/define.ts:119

Rule ids or globs to remove from what earlier constants defined.

---

id

readonly id: string

Defined in: packages/validator/src/rulesets/define.ts:121

Ruleset id.

---

normalize?

readonly optional normalize?: Normalizer

Defined in: packages/validator/src/rulesets/define.ts:123

Defaults hook, when the ruleset has one.

---

override

readonly override: Readonly<Record<string, RuleOverride>>

Defined in: packages/validator/src/rulesets/define.ts:125

Patches to rules earlier constants defined, by id.

---

requires

readonly requires: readonly Ruleset[]

Defined in: packages/validator/src/rulesets/define.ts:127

Rulesets that must appear earlier in every list this one is in.

---

rules

readonly rules: readonly Rule<unknown>[]

Defined in: packages/validator/src/rulesets/define.ts:129

The rules.

---

spec

readonly spec: Readonly<Record<string, string>>

Defined in: packages/validator/src/rulesets/define.ts:131

The specification versions the ruleset implements.

---

version

readonly version: string

Defined in: packages/validator/src/rulesets/define.ts:133

Ruleset version.

---

when?

readonly optional when?: (ctx) => boolean

Defined in: packages/validator/src/rulesets/define.ts:140

Document-level gate of every rule of the ruleset, when it has one.

Parameters

ctx

RuleContext

The rule context.

Returns

boolean

Whether the ruleset applies to the document.