treetrunks

npm i treetrunks

treetrunks is a convenient way to define type-safe routers.

overview

a tree structure affords many possible routes through the tree

import type { Tree, TreePath } from "treetrunks";
import { optional, required } from "treetrunks";

const greetingTree = required({
  hello: optional({
    world: null,
    $name: optional({
      good: required({
        morning: null,
      }),
    }),
  }),
}) satisfies Tree;

const validPaths: TreePath<typeof greetingTree>[] = [
  [`hello`],
  [`hello`, `world`],
  [`hello`, `jeremybanka`],
  [`hello`, `treetrunks`, `good`, `morning`],
];

the optional and required functions help determine what routes are valid.

note that,

• "hello" is required
• "world", or any $name is optional
• "good morning" is optional