Skip to main content

diagnostics

Functions​

computeChecks()​

function computeChecks(__namedParameters): object;

Parameters​

ParameterType
__namedParametersDiagnosticInput

Returns​

object

NameType
checksCheck[]
overallCheckState

summarizeInternalNodes()​

function summarizeInternalNodes(summary?): object;

Parameters​

ParameterType
summary?{ materials: object[]; nodes: object[]; }
summary.materialsobject[]
summary.nodesobject[]

Returns​

object

NameType
types[string, number][]
countnumber

Interfaces​

Check​

Properties​

PropertyType
namestring
stateCheckState
messagesstring[]

ValidationIssue​

Properties​

PropertyType
level"error" | "warning"
rule?string
code?string
locationstring
messagestring

PreviewReport​

Properties​

PropertyType
state"error" | "idle" | "loading" | "ready"
resources"unchecked" | "loading" | "loaded"
failedResourcesstring[]

DiagnosticInput​

Properties​

PropertyType
issuesValidationIssue[]
parseError?string
viewerError?string | null
preview?PreviewReport
resourcesChecked?boolean
dependencyHint?string

Type Aliases​

CheckState​

type CheckState = "passed" | "failed" | "warning" | "pending" | "unchecked";

Framework-independent diagnostics shared by the website and editor webview.