Skip to content

PromptScript API


Interface: OutputConvention

Defined in: core/src/types/convention.ts:58

Output convention definition.

Properties

codeBlockDelimiter?

optional codeBlockDelimiter: string

Defined in: core/src/types/convention.ts:89

Code block delimiter.

Default

'```'

description?

optional description: string

Defined in: core/src/types/convention.ts:67

Human-readable description.


listStyle?

optional listStyle: "dash" | "asterisk" | "bullet" | "numbered"

Defined in: core/src/types/convention.ts:83

How to render lists.

Default

'dash' (- item)

name

name: string

Defined in: core/src/types/convention.ts:62

Convention identifier.


rootWrapper?

optional rootWrapper: object

Defined in: core/src/types/convention.ts:94

Whether to wrap content in a root element.

end

end: string

start

start: string


section

section: SectionRenderer

Defined in: core/src/types/convention.ts:72

Section rendering configuration.


subsection?

optional subsection: SectionRenderer

Defined in: core/src/types/convention.ts:77

Subsection rendering (defaults to section config if not specified).