IFClite TypeScript API
    Preparing search index...

    Interface Diagnostic

    interface Diagnostic {
        code: string;
        docsUrl: string;
        field?:
            | "attribute.name"
            | "attribute.value"
            | "property.propertySet"
            | "property.baseName"
            | "property.dataType"
            | "property.value"
            | "material.value"
            | "classification.system"
            | "classification.value"
            | "entity.name"
            | "entity.predefinedType"
            | "partOf.entity.name"
            | "partOf.entity.predefinedType";
        fixes?: QuickFix[];
        message: string;
        nodeId: string;
        severity: LintSeverity;
        specId?: string;
        why?: string;
    }
    Index
    code docsUrl field? fixes? message nodeId severity specId? why?
    code: string

    Stable rule code, e.g. IDSL-REGEX-001.

    docsUrl: string

    Per-rule documentation page.

    field?:
        | "attribute.name"
        | "attribute.value"
        | "property.propertySet"
        | "property.baseName"
        | "property.dataType"
        | "property.value"
        | "material.value"
        | "classification.system"
        | "classification.value"
        | "entity.name"
        | "entity.predefinedType"
        | "partOf.entity.name"
        | "partOf.entity.predefinedType"
    fixes?: QuickFix[]
    message: string
    nodeId: string

    The most specific node the finding is about: a constraint node when field is set, else a requirement / applicability facet, a specification or the document node.

    severity: LintSeverity
    specId?: string

    The specification the node belongs to (absent for document findings).

    why?: string

    Long-form explanation (the rule's rationale).

    Settings
    Member Visibility

    On This Page
    Properties