printTree

Convert a rendered text tree to a string. Will ensure that the scheduler is empty before printing.

import { printTree } from "@alloy-js/core";

function printTree(tree: RenderedTextTree, options?: PrintTreeOptions): string;

Parameters

tree	RenderedTextTree
options	optional PrintTreeOptions

Options

insertFinalNewLine	optionalboolean If files should end with a final new line.
noFlush	optionalboolean Skip flushing scheduled jobs before printing.
printWidth	optionalnumber The number of characters the printer will wrap on. Defaults to 100 characters.
tabWidth	optionalnumber The number of spaces to use for indentation. Defaults to 2 spaces.
useTabs	optionalboolean Whether to use tabs instead of spaces for indentation. Defaults to false.

Returns

string