Documentation / @facturometro/validator / RulesetRegistration

Interface: RulesetRegistration

Defined in: packages/validator/src/rulesets/registry.ts:33

A composition registered for a customization id.

Example

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

const registration: RulesetRegistration = {
  customizationId: 'urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0#acme',
  ruleset: [en16931Ruleset, peppolRuleset, acme],
};

Properties

customizationId

readonly customizationId: string

Defined in: packages/validator/src/rulesets/registry.ts:35

The cbc:CustomizationID documents must carry to resolve to the composition.

---

matchPrefix?

readonly optional matchPrefix?: boolean

Defined in: packages/validator/src/rulesets/registry.ts:40

Whether documents whose customization id merely starts with customizationId resolve to it too (the PEPPOL-EN16931-R004 semantics of a suffixed CIUS id). Off by default.

---

ruleset

readonly ruleset: RulesetComposition

Defined in: packages/validator/src/rulesets/registry.ts:42

The composition to run.