• Preparing search index...
  • The search index is not available
@xeokit/sdk - v0.1.0
  • @xeokit/sdk
  • inspect
  • sceneModel
  • descriptionForCode

Function descriptionForCode

  • descriptionForCode(
        code: string,
        registry?: inspect.sceneModel.InspectionRegistry,
    ): string

    Resolve an issue code to a plain-English description by consulting the descriptions maps on every Inspection registered in registry (default DEFAULT_INSPECTION_REGISTRY).

    UIs use this to surface a "What is this?" sentence above a panel of issues that share a code — describing the underlying problem rather than what the registered Fix would do about it.

    Returns the empty string when no inspection in the registry registers a description for code. UIs should treat the absence as "skip the description card", not as a fallback to the code itself.

    Parameters

    • code: string

      The issue code to look up.

    • registry: inspect.sceneModel.InspectionRegistry = DEFAULT_INSPECTION_REGISTRY

      The registry to walk. Defaults to DEFAULT_INSPECTION_REGISTRY.

    Returns string

    The description, or "" when no inspection in the registry registers one.

    • Defined in packages/sdk/src/inspect/sceneModel/labels/descriptionForCode.ts:27

Settings

Member Visibility
@xeokit/sdk - v0.1.0
  • Loading...

Generated using TypeDoc