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

Function inspectDataModel

  • inspectDataModel(
        params: InspectDataModelParams,
    ): inspect.dataModel.InspectionReport

    Validate a DataModel against optional schema rules.

    Walks every Inspection in the configured InspectionRegistry, returns an InspectionReport bucketed by severity and by code. Never mutates the DataModel. No auto-fix counterpart — SDK policy is to surface defects rather than rewrite user data.

    Inspections that need a schema no-op silently when one isn't supplied; the always-on structural checks still fire. Opt-in inspections gate themselves against their check… flag.

    import {inspectDataModel} from "@xeokit/sdk/inspect/dataModel";

    const report = inspectDataModel({dataModel, schema});
    if (report.errors.length > 0) { ... }

    Parameters

    • params: InspectDataModelParams

    Returns inspect.dataModel.InspectionReport

    • Defined in packages/sdk/src/inspect/dataModel/inspectDataModel.ts:28

Settings

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

Generated using TypeDoc