a2bt v3.1.2

a2bt

Prints an ASCII representation of a binary tree.

Install

npm install a2bt

or

yarn add a2bt

install CLI globally

npm install -g a2bt

CLI

Use null for empty nodes.

  $ a2bt <json_array>

Options

  --json, -j  Output tree to JSON string
  --addend, -a Increases the height of the tree. Useful when leaf nodes overlap due to long values
  --grid, -g show number grid instead of whitespace
  --fgColor -f A 4bit ANSI color that ranges from 30-37 and 90-97 inclusive.
  --bst Output data as Binary Search Tree

The values and their associated color mappings for --fgColor are

API

import a2bt, { toConsole, rootToArray } from "a2bt";
import type { TreeNode } from "a2bt/dist/rootToArray";

const addend = 1;
const grid = true;
const nodes = ["aaa", "bbb", "ccc"];
const fgColor = 93;

toConsole(a2bt(nodes, addend, grid, fgColor));

//--------------------

const root: TreeNode = {
  val: 1,
  left: {
    val: 2,
    right: {
      val: 4,
    },
  },
  right: {
    val: 3,
  },
};
const array: string[] = [];

// You can use rootToArray to convert an TreeNode root into an array so that it can be used with a2bt.
rootToArray(array, root);

toConsole(a2bt(array));

See https://github.com/aprax/a2bt_example for more examples

Examples

These examples use Bash. If using zsh you will need to wrap quotes around the argument like $ a2bt '[1,2,3]'

$ a2bt [1,2,3]
    1
  /   \
 /     \
2       3

$ a2bt [1,null,3,null,null,6]
                 1
                  \
                   \
                    \
                     \
                      \
                       \
                        \
                         \
                          3
                         /
                        /
                       /
                      /
                     6

$ a2bt '["a","b","c",null,null,"d","e",null,null,null,null,"f"]'
                                  a
                                 / \
                                /   \
                               /     \
                              /       \
                             /         \
                            /           \
                           /             \
                          /               \
                         /                 \
                        /                   \
                       /                     \
                      /                       \
                     /                         \
                    /                           \
                   /                             \
                  /                               \
                 b                                 c
                                                  / \
                                                 /   \
                                                /     \
                                               /       \
                                              /         \
                                             /           \
                                            /             \
                                           /               \
                                          d                 e
                                         /
                                        /
                                       /
                                      /
                                     f

$ a2bt ["@","#","$"] -g
123@567
12/4\67
1/345\7
#23456$

$ a2bt '["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k"]' --bst
                 f
                / \
               /   \
              /     \
             /       \
            /         \
           /           \
          /             \
         /               \
        c                 i
       / \               / \
      /   \             /   \
     /     \           /     \
    /       \         /       \
   a         d       g         j
    \         \       \         \
     \         \       \         \
      b         e       h         k

Build

Builds to dist/index.js for API and dist/cli.js for CLI.

$ yarn build

Run locally

$ yarn start [1,2,3]