Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/rulvar / FinishContractCitations

Interface: FinishContractCitations

Defined in: packages/core/dist/index.d.ts

The citation demands of a FinishContractManifest.

Properties

PropertyTypeDescriptionDefined in
flags?string-packages/core/dist/index.d.ts
min?numberTotal matches required across the whole result text.packages/core/dist/index.d.ts
pattern?stringRegex source over the result text; default DEFAULT_CITATION_PATTERN.packages/core/dist/index.d.ts
perSection?numberMatches required inside EVERY declared section; requires sections.packages/core/dist/index.d.ts
sample?stringA literal string matching pattern, embedded in the golden fixtures (a regex cannot be sampled mechanically). REQUIRED with a custom pattern; defaults to DEFAULT_CITATION_SAMPLE for the default pattern. Must contain no whitespace and no declared section marker.packages/core/dist/index.d.ts