render

Render a component tree to source directories and files. Will ensure that all non-async scheduled jobs are completed before returning. If async jobs are found, an error will be thrown. Use renderAsync when asynchronous jobs are expected.

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

function render(children: Children, options?: PrintTreeOptions): OutputDirectory;

Parameters

children	Children
options	optional PrintTreeOptions

Options

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

Returns

OutputDirectory