Skip to main content

Function: requirementKeywordOf()

requirementKeywordOf(statement): "MUST NOT" | "MUST" | "SHALL NOT" | "SHALL" | "REQUIRED" | "SHOULD NOT" | "SHOULD" | "NOT RECOMMENDED" | "RECOMMENDED" | "MAY" | "OPTIONAL" | undefined

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

The keyword a requirement opens with, longest match first, so MUST NOT verify reads as MUST NOT and not as MUST.

Parameters​

statement​

string

A requirement's text; one that passed RequirementStatement always has a keyword.

Returns​

"MUST NOT" | "MUST" | "SHALL NOT" | "SHALL" | "REQUIRED" | "SHOULD NOT" | "SHOULD" | "NOT RECOMMENDED" | "RECOMMENDED" | "MAY" | "OPTIONAL" | undefined

The keyword, or undefined for text that does not open with one.