Skip to content

file

Estimated time to read: 3 minutes

POML TypeScript API


Classes

PomlFile

Defined in: packages/poml/file.tsx:56

Constructors

Constructor

new PomlFile(text, options?, sourcePath?): PomlFile

Defined in: packages/poml/file.tsx:71

Parameters
text

string

options?

PomlReaderOptions

sourcePath?

string

Returns

PomlFile

Methods

getCompletions()

getCompletions(offset): PomlToken[]

Defined in: packages/poml/file.tsx:312

Parameters
offset

number

Returns

PomlToken[]

getExpressionEvaluations()

getExpressionEvaluations(range): any[]

Defined in: packages/poml/file.tsx:427

Parameters
range

Range

Returns

any[]

getExpressionTokens()

getExpressionTokens(): PomlToken[]

Defined in: packages/poml/file.tsx:334

Returns

PomlToken[]

getHoverToken()

getHoverToken(offset): undefined | PomlToken

Defined in: packages/poml/file.tsx:304

Parameters
offset

number

Returns

undefined | PomlToken

getResponseSchema()

getResponseSchema(): undefined | Schema

Defined in: packages/poml/file.tsx:253

Returns

undefined | Schema

getRuntimeParameters()

getRuntimeParameters(): undefined | {[key: string]: any; }

Defined in: packages/poml/file.tsx:261

Returns

undefined | {[key: string]: any; }

getToolsSchema()

getToolsSchema(): undefined | ToolsSchema

Defined in: packages/poml/file.tsx:257

Returns

undefined | ToolsSchema

react()

react(context?): ReactElement

Defined in: packages/poml/file.tsx:277

Parameters
context?
Returns

ReactElement

xmlRootElement()

xmlRootElement(): undefined | XMLElement

Defined in: packages/poml/file.tsx:265

Returns

undefined | XMLElement

Interfaces

PomlReaderOptions

Defined in: packages/poml/file.tsx:27

Properties

autoAddPoml?

optional autoAddPoml: boolean

Defined in: packages/poml/file.tsx:29

crlfToLf?

optional crlfToLf: boolean

Defined in: packages/poml/file.tsx:30

trim?

optional trim: boolean

Defined in: packages/poml/file.tsx:28


PomlToken

Defined in: packages/poml/file.tsx:39

Properties

attribute?

optional attribute: string

Defined in: packages/poml/file.tsx:43

element?

optional element: string

Defined in: packages/poml/file.tsx:42

expression?

optional expression: string

Defined in: packages/poml/file.tsx:45

range

range: Range

Defined in: packages/poml/file.tsx:41

type

type: "element" | "attribute" | "attributeValue" | "expression"

Defined in: packages/poml/file.tsx:40

value?

optional value: string

Defined in: packages/poml/file.tsx:44