Skip to content

PromptScript API


Interface: BrowserCompilerOptions

Defined in: browser-compiler/src/compiler.ts:56

Options for the browser compiler.

Properties

cache?

optional cache?: boolean

Defined in: browser-compiler/src/compiler.ts:70

Whether to cache resolved ASTs. Defaults to true.


customConventions?

optional customConventions?: Record\<string, OutputConvention>

Defined in: browser-compiler/src/compiler.ts:64

Custom convention definitions


envVars?

optional envVars?: Record\<string, string>

Defined in: browser-compiler/src/compiler.ts:78

Simulated environment variables for interpolation. When provided, ${VAR} and ${VAR:-default} syntax in source files will be replaced with values from this map.


formatters?

optional formatters?: (string | Formatter | { config?: TargetConfig; name: string; })[]

Defined in: browser-compiler/src/compiler.ts:62

Formatters to use (names, instances, or configs)


fs

fs: VirtualFileSystem

Defined in: browser-compiler/src/compiler.ts:58

Virtual file system containing all files


logger?

optional logger?: Logger

Defined in: browser-compiler/src/compiler.ts:68

Logger for verbose/debug output


prettier?

optional prettier?: PrettierMarkdownOptions

Defined in: browser-compiler/src/compiler.ts:66

Prettier formatting options for markdown output


projectRoot?

optional projectRoot?: string

Defined in: browser-compiler/src/compiler.ts:72

Virtual project root containing .promptscript/scripts.


validator?

optional validator?: ValidatorConfig

Defined in: browser-compiler/src/compiler.ts:60

Validator configuration