Skip to main content

Variable: RFC2119_KEYWORDS

const RFC2119_KEYWORDS: object

Defined in: packages/contracts/src/schemas/governance-metamodel.ts:39

The RFC 2119 keywords, each with the class the Metamodel gives it. Only the capitalised spelling is a keyword (RFC 8174), so "the holder must" in prose is just English. Ordered longest first wherever one is a prefix of another (MUST NOT before MUST), because the pattern and requirementClassOf take the first that fits.

Type Declaration​

MAY​

readonly MAY: "option" = 'option'

MUST​

readonly MUST: "mandatory" = 'mandatory'

MUST NOT​

readonly MUST NOT: "mandatory" = 'mandatory'

readonly NOT RECOMMENDED: "recommendation" = 'recommendation'

OPTIONAL​

readonly OPTIONAL: "option" = 'option'

readonly RECOMMENDED: "recommendation" = 'recommendation'

REQUIRED​

readonly REQUIRED: "mandatory" = 'mandatory'

SHALL​

readonly SHALL: "mandatory" = 'mandatory'

SHALL NOT​

readonly SHALL NOT: "mandatory" = 'mandatory'

SHOULD​

readonly SHOULD: "recommendation" = 'recommendation'

SHOULD NOT​

readonly SHOULD NOT: "recommendation" = 'recommendation'