Output

This component is the root component for all your emitted output. Place your various SourceDirectory and SourceFile components inside Output to create directories and files in your output directory.

jsx

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

<Output
  basePath="string"
  externals={SymbolCreator[]}
  insertFinalNewLine
  nameConflictResolver={NameConflictResolver}
  namePolicy={NamePolicy<string>}
  noFlush
  printWidth={number}
  tabWidth={number}
  useTabs
>
  {children}
</Output>

stc

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

Output({
  basePath: string,
  externals: SymbolCreator[],
  insertFinalNewLine: boolean,
  nameConflictResolver: NameConflictResolver,
  namePolicy: NamePolicy<string>,
  noFlush: boolean,
  printWidth: number,
  tabWidth: number,
  useTabs: boolean,
}).children(children)

Props

basePath	optional string	The base path for the output contents. Defaults to ”.“
children	optional Children
externals	optional SymbolCreator[]	External libraries whose symbols should be available for reference.
insertFinalNewLine	optional boolean	If files should end with a final new line.
nameConflictResolver	optional NameConflictResolver	Policy for handling multiple symbols declared with the same name.
namePolicy	optional NamePolicy<string>	Name policy to use for this output.
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.

See also

• NamePolicy context