API

Interface IKHRInteractivityExportDiagnostic

Structured KHR_interactivity export diagnostic.

interface IKHRInteractivityExportDiagnostic {
    blockId?: string;
    code:
        | "GRAPH_SOURCE_MISSING"
        | "GRAPH_COUNT_MISMATCH"
        | "NODE_SOURCE_MISSING"
        | "BLOCK_PROVENANCE_INVALID"
        | "BLOCK_ROLE_MISSING"
        | "BLOCK_ROLE_DUPLICATE"
        | "BLOCK_TYPE_MISMATCH"
        | "BLOCK_UNSUPPORTED"
        | "BLOCK_AMBIGUOUS"
        | "COMPOSITE_CONNECTION_CHANGED"
        | "SOCKET_PROVENANCE_MISSING"
        | "SOCKET_CONNECTION_AMBIGUOUS"
        | "SOCKET_TARGET_UNREPRESENTABLE"
        | "INPUT_DEFAULT_UNREPRESENTABLE"
        | "VALUE_UNREPRESENTABLE"
        | "CONFIGURATION_UNREPRESENTABLE"
        | "REFERENCE_UNRESOLVED"
        | "DEPENDENCY_CYCLE"
        | "GRAPH_INVALID";
    graphIndex?: number;
    message: string;
    nodeIndex?: number;
    path: string;
    severity: "error"
    | "warning";
    socket?: string;
}
Index
blockId?: string

FlowGraph block id, when known.

code:
    | "GRAPH_SOURCE_MISSING"
    | "GRAPH_COUNT_MISMATCH"
    | "NODE_SOURCE_MISSING"
    | "BLOCK_PROVENANCE_INVALID"
    | "BLOCK_ROLE_MISSING"
    | "BLOCK_ROLE_DUPLICATE"
    | "BLOCK_TYPE_MISMATCH"
    | "BLOCK_UNSUPPORTED"
    | "BLOCK_AMBIGUOUS"
    | "COMPOSITE_CONNECTION_CHANGED"
    | "SOCKET_PROVENANCE_MISSING"
    | "SOCKET_CONNECTION_AMBIGUOUS"
    | "SOCKET_TARGET_UNREPRESENTABLE"
    | "INPUT_DEFAULT_UNREPRESENTABLE"
    | "VALUE_UNREPRESENTABLE"
    | "CONFIGURATION_UNREPRESENTABLE"
    | "REFERENCE_UNRESOLVED"
    | "DEPENDENCY_CYCLE"
    | "GRAPH_INVALID"

Stable diagnostic code.

graphIndex?: number

Source graph index, when known.

message: string

Human-readable actionable diagnostic.

nodeIndex?: number

Source node index, when known.

path: string

JSON pointer or FlowGraph location associated with the issue.

severity: "error" | "warning"

Diagnostic severity.

socket?: string

KHR socket id, when known.