traverse

Traverse n-tree with strategy. The default strategy is bfs.

Types

type TreeNode<Key extends string = 'children'> = {
  [p in Key]?: TreeNode<Key>[];
}

type TraverseCallback<Node = TreeNode> = (node: Node, pNode?: Node) => void

type TraverseOptions = {
  strategy?: 'bfs' | 'pre' | 'post'
  property?: string
}

function traverse<TNode = TreeNode>(
  root: TNode,
  callback: TraverseCallback<typeof root>,
  options?: TraverseOptions,
): void

Example

Bfs as default

javascript

import { traverse } from '@a-tools/n-tree'

const root = { children: [] }

traverse(root, (cur, parent) => {
  console.log(cur, parent)
})

typescript

import { traverse } from '@a-tools/n-tree'

const root = { children: [] }

traverse(root, (cur, parent) => {
  console.log(cur, parent)
})

Specified strategy

javascript

import { traverse } from '@a-tools/n-tree'

const root = { children: [] }

traverse(root, (cur, parent) => {
  console.log(cur, parent)
}, { strategy: 'pre' })

typescript

import { traverse } from '@a-tools/n-tree'

const root = { children: [] }

traverse(root, (cur, parent) => {
  console.log(cur, parent)
}, { strategy: 'pre' })

Specified child property

javascript

import { traverse } from '@a-tools/n-tree'

const root = { child: [] }

traverse(root, (cur, parent) => {
  console.log(cur, parent)
}, { property: 'child' })

typescript

import { traverse } from '@a-tools/n-tree'

type TreeNode = { child?: TreeNode }

const root: TreeNode = { child: [] }

traverse<TreeNode>(root, (cur, parent) => {
  console.log(cur, parent)
}, { property: 'child' })