IFClite TypeScript API
    Preparing search index...

    Interface RequirementResult

    Result for a single requirement check, generalised over its source.

    interface RequirementResult {
        actualValue?: string;
        checkedDescription: string;
        expectedValue?: string;
        facetType: CheckKind;
        failure?: IDSFailureDetail;
        failureReason?: string;
        requirement: RequirementSummary;
        status: "pass" | "fail" | "not_applicable";
    }
    Index
    actualValue? checkedDescription expectedValue? facetType failure? failureReason? requirement status
    actualValue?: string

    Actual value found

    checkedDescription: string

    Human-readable description of what was checked (translated)

    expectedValue?: string

    Expected value/constraint description

    facetType: CheckKind

    The kind of check that was performed

    failure?: IDSFailureDetail

    Detailed failure information (IDS only)

    failureReason?: string

    Human-readable failure reason (translated IDS text, or a FailureReasonCode)

    requirement: RequirementSummary

    Reference to the requirement

    status: "pass" | "fail" | "not_applicable"

    Pass/fail status

    Settings
    Member Visibility

    On This Page
    Properties