validate

GitHub View source

Validate the integrity of a tree structure, returning whether it is valid along with a list of errors describing any problems.

Usage

The validate method checks whether a tree structure is valid. It primarily checks for two issues:

Whether there are duplicate node ids.
Whether there are circular references (i.e., a node is an ancestor of itself).

example.ts

import { Tree } from '@movk/core'

// Valid tree
const validTree = [{ id: 1, children: [{ id: 2 }] }]
Tree.validate(validTree) // no error thrown

// Invalid tree (duplicate IDs)
const invalidTree1 = [{ id: 1 }, { id: 1 }]
try {
  Tree.validate(invalidTree1)
}
catch (e) {
  console.error(e.message) // "Duplicate ID found: 1"
}

// Invalid tree (circular reference)
const node1 = { id: 1 }
const node2 = { id: 2, children: [node1] }
node1.children = [node2]
const invalidTree2 = [node1]
try {
  Tree.validate(invalidTree2)
}
catch (e) {
  console.error(e.message) // "Circular reference detected in node ID: 2"
}