components

Estimated time to read: 22 minutes

POML TypeScript API

---

Interfaces

BaseCaptionedParagraphProps

Defined in: packages/poml/components/utils.tsx:15

Extends

• PropsSyntaxAny

Properties

captionEnding?

optional captionEnding: "newline" | "none" | "colon" | "colon-newline"

Defined in: packages/poml/components/utils.tsx:19

captionSerialized?

optional captionSerialized: string

Defined in: packages/poml/components/utils.tsx:16

captionStyle?

optional captionStyle: "header" | "bold" | "plain" | "hidden"

Defined in: packages/poml/components/utils.tsx:17

captionTailingSpace?

optional captionTailingSpace: boolean

Defined in: packages/poml/components/utils.tsx:20

captionTextTransform?

optional captionTextTransform: "upper" | "lower" | "capitalize" | "none"

Defined in: packages/poml/components/utils.tsx:18

charLimit?

optional charLimit: number

Defined in: packages/poml/base.tsx:143

Soft character limit before truncation is applied.

Inherited from

PropsSyntaxAny.charLimit

className?

optional className: string

Defined in: packages/poml/base.tsx:128

Inherited from

PropsSyntaxAny.className

name?

optional name: string

Defined in: packages/poml/presentation.tsx:489

Inherited from

PropsSyntaxAny.name

originalEndIndex?

optional originalEndIndex: number

Defined in: packages/poml/base.tsx:133

Inherited from

PropsSyntaxAny.originalEndIndex

originalStartIndex?

optional originalStartIndex: number

Defined in: packages/poml/base.tsx:132

Inherited from

PropsSyntaxAny.originalStartIndex

priority?

optional priority: number

Defined in: packages/poml/base.tsx:147

Priority used when truncating globally. Lower numbers are dropped first.

Inherited from

PropsSyntaxAny.priority

sourcePath?

optional sourcePath: string

Defined in: packages/poml/base.tsx:136

Inherited from

PropsSyntaxAny.sourcePath

speaker?

optional speaker: Speaker

Defined in: packages/poml/base.tsx:127

Inherited from

PropsSyntaxAny.speaker

syntax?

optional syntax: string

Defined in: packages/poml/essentials.tsx:21

Inherited from

PropsSyntaxAny.syntax

tokenLimit?

optional tokenLimit: number

Defined in: packages/poml/base.tsx:145

Soft token limit before truncation is applied.

Inherited from

PropsSyntaxAny.tokenLimit

type?

optional type: AnyValue

Defined in: packages/poml/presentation.tsx:490

Inherited from

PropsSyntaxAny.type

whiteSpace?

optional whiteSpace: "filter" | "pre" | "trim"

Defined in: packages/poml/base.tsx:140

Inherited from

PropsSyntaxAny.whiteSpace

writerOptions?

optional writerOptions: object

Defined in: packages/poml/base.tsx:139

Inherited from

PropsSyntaxAny.writerOptions

---

FolderProps

Defined in: packages/poml/components/tree.tsx:312

Props base serves the following props subclass, as far as I can now think of: 1. Props for markup basic components 2. Props for serialization basic components 3. Props for essential general components 3.1. Props for other high-level components

Extends

• PropsSyntaxBase

Properties

charLimit?

optional charLimit: number

Defined in: packages/poml/base.tsx:143

Soft character limit before truncation is applied.

Inherited from

PropsSyntaxBase.charLimit

className?

optional className: string

Defined in: packages/poml/base.tsx:128

Inherited from

PropsSyntaxBase.className

data?

optional data: TreeItemData[]

Defined in: packages/poml/components/tree.tsx:314

filter?

optional filter: string | RegExp

Defined in: packages/poml/components/tree.tsx:315

maxDepth?

optional maxDepth: number

Defined in: packages/poml/components/tree.tsx:316

originalEndIndex?

optional originalEndIndex: number

Defined in: packages/poml/base.tsx:133

Inherited from

PropsSyntaxBase.originalEndIndex

originalStartIndex?

optional originalStartIndex: number

Defined in: packages/poml/base.tsx:132

Inherited from

PropsSyntaxBase.originalStartIndex

priority?

optional priority: number

Defined in: packages/poml/base.tsx:147

Priority used when truncating globally. Lower numbers are dropped first.

Inherited from

PropsSyntaxBase.priority

showContent?

optional showContent: boolean

Defined in: packages/poml/components/tree.tsx:317

sourcePath?

optional sourcePath: string

Defined in: packages/poml/base.tsx:136

Inherited from

PropsSyntaxBase.sourcePath

speaker?

optional speaker: Speaker

Defined in: packages/poml/base.tsx:127

Inherited from

PropsSyntaxBase.speaker

src?

optional src: string

Defined in: packages/poml/components/tree.tsx:313

syntax?

optional syntax: string

Defined in: packages/poml/essentials.tsx:21

Inherited from

PropsSyntaxBase.syntax

tokenLimit?

optional tokenLimit: number

Defined in: packages/poml/base.tsx:145

Soft token limit before truncation is applied.

Inherited from

PropsSyntaxBase.tokenLimit

whiteSpace?

optional whiteSpace: "filter" | "pre" | "trim"

Defined in: packages/poml/base.tsx:140

Inherited from

PropsSyntaxBase.whiteSpace

writerOptions?

optional writerOptions: object

Defined in: packages/poml/base.tsx:139

Inherited from

PropsSyntaxBase.writerOptions

---

RecordColumns

Defined in: packages/poml/components/table.tsx:17

Properties

columns?

optional columns: ColumnDefinition[]

Defined in: packages/poml/components/table.tsx:19

records

records: any[]

Defined in: packages/poml/components/table.tsx:18

---

TableProps

Defined in: packages/poml/components/table.tsx:24

Props base serves the following props subclass, as far as I can now think of: 1. Props for markup basic components 2. Props for serialization basic components 3. Props for essential general components 3.1. Props for other high-level components

Extends

• PropsSyntaxBase

Properties

charLimit?

optional charLimit: number

Defined in: packages/poml/base.tsx:143

Soft character limit before truncation is applied.

Inherited from

PropsSyntaxBase.charLimit

className?

optional className: string

Defined in: packages/poml/base.tsx:128

Inherited from

PropsSyntaxBase.className

columns?

optional columns: ColumnDefinition[]

Defined in: packages/poml/components/table.tsx:26

maxColumns?

optional maxColumns: number

Defined in: packages/poml/components/table.tsx:32

maxRecords?

optional maxRecords: number

Defined in: packages/poml/components/table.tsx:31

originalEndIndex?

optional originalEndIndex: number

Defined in: packages/poml/base.tsx:133

Inherited from

PropsSyntaxBase.originalEndIndex

originalStartIndex?

optional originalStartIndex: number

Defined in: packages/poml/base.tsx:132

Inherited from

PropsSyntaxBase.originalStartIndex

parser?

optional parser: TableParser

Defined in: packages/poml/components/table.tsx:28

priority?

optional priority: number

Defined in: packages/poml/base.tsx:147

Priority used when truncating globally. Lower numbers are dropped first.

Inherited from

PropsSyntaxBase.priority

records?

optional records: string | any[]

Defined in: packages/poml/components/table.tsx:25

selectedColumns?

optional selectedColumns: string | string[]

Defined in: packages/poml/components/table.tsx:29

selectedRecords?

optional selectedRecords: string | number[]

Defined in: packages/poml/components/table.tsx:30

sourcePath?

optional sourcePath: string

Defined in: packages/poml/base.tsx:136

Inherited from

PropsSyntaxBase.sourcePath

speaker?

optional speaker: Speaker

Defined in: packages/poml/base.tsx:127

Inherited from

PropsSyntaxBase.speaker

src?

optional src: string

Defined in: packages/poml/components/table.tsx:27

syntax?

optional syntax: string

Defined in: packages/poml/essentials.tsx:21

Inherited from

PropsSyntaxBase.syntax

tokenLimit?

optional tokenLimit: number

Defined in: packages/poml/base.tsx:145

Soft token limit before truncation is applied.

Inherited from

PropsSyntaxBase.tokenLimit

whiteSpace?

optional whiteSpace: "filter" | "pre" | "trim"

Defined in: packages/poml/base.tsx:140

Inherited from

PropsSyntaxBase.whiteSpace

writerOptions?

optional writerOptions: object

Defined in: packages/poml/base.tsx:139

Inherited from

PropsSyntaxBase.writerOptions

---

TreeItemData

Defined in: packages/poml/components/tree.tsx:17

Properties

children?

optional children: TreeItemData[]

Defined in: packages/poml/components/tree.tsx:20

name

name: string

Defined in: packages/poml/components/tree.tsx:18

value?

optional value: string

Defined in: packages/poml/components/tree.tsx:19

---

TreeProps

Defined in: packages/poml/components/tree.tsx:23

Props base serves the following props subclass, as far as I can now think of: 1. Props for markup basic components 2. Props for serialization basic components 3. Props for essential general components 3.1. Props for other high-level components

Extends

• PropsSyntaxBase

Properties

charLimit?

optional charLimit: number

Defined in: packages/poml/base.tsx:143

Soft character limit before truncation is applied.

Inherited from

PropsSyntaxBase.charLimit

className?

optional className: string

Defined in: packages/poml/base.tsx:128

Inherited from

PropsSyntaxBase.className

items

items: TreeItemData[]

Defined in: packages/poml/components/tree.tsx:24

originalEndIndex?

optional originalEndIndex: number

Defined in: packages/poml/base.tsx:133

Inherited from

PropsSyntaxBase.originalEndIndex

originalStartIndex?

optional originalStartIndex: number

Defined in: packages/poml/base.tsx:132

Inherited from

PropsSyntaxBase.originalStartIndex

priority?

optional priority: number

Defined in: packages/poml/base.tsx:147

Priority used when truncating globally. Lower numbers are dropped first.

Inherited from

PropsSyntaxBase.priority

showContent?

optional showContent: boolean

Defined in: packages/poml/components/tree.tsx:25

sourcePath?

optional sourcePath: string

Defined in: packages/poml/base.tsx:136

Inherited from

PropsSyntaxBase.sourcePath

speaker?

optional speaker: Speaker

Defined in: packages/poml/base.tsx:127

Inherited from

PropsSyntaxBase.speaker

syntax?

optional syntax: string

Defined in: packages/poml/essentials.tsx:21

Inherited from

PropsSyntaxBase.syntax

tokenLimit?

optional tokenLimit: number

Defined in: packages/poml/base.tsx:145

Soft token limit before truncation is applied.

Inherited from

PropsSyntaxBase.tokenLimit

whiteSpace?

optional whiteSpace: "filter" | "pre" | "trim"

Defined in: packages/poml/base.tsx:140

Inherited from

PropsSyntaxBase.whiteSpace

writerOptions?

optional writerOptions: object

Defined in: packages/poml/base.tsx:139

Inherited from

PropsSyntaxBase.writerOptions

---

WebpageProps

Defined in: packages/poml/components/webpage.tsx:9

Props base serves the following props subclass, as far as I can now think of: 1. Props for markup basic components 2. Props for serialization basic components 3. Props for essential general components 3.1. Props for other high-level components

Extends

• PropsSyntaxBase

Properties

base64?

optional base64: string

Defined in: packages/poml/components/webpage.tsx:13

buffer?

optional buffer: string | Buffer\<ArrayBufferLike>

Defined in: packages/poml/components/webpage.tsx:12

charLimit?

optional charLimit: number

Defined in: packages/poml/base.tsx:143

Soft character limit before truncation is applied.

Inherited from

PropsSyntaxBase.charLimit

className?

optional className: string

Defined in: packages/poml/base.tsx:128

Inherited from

PropsSyntaxBase.className

extractText?

optional extractText: boolean

Defined in: packages/poml/components/webpage.tsx:14

originalEndIndex?

optional originalEndIndex: number

Defined in: packages/poml/base.tsx:133

Inherited from

PropsSyntaxBase.originalEndIndex

originalStartIndex?

optional originalStartIndex: number

Defined in: packages/poml/base.tsx:132

Inherited from

PropsSyntaxBase.originalStartIndex

priority?

optional priority: number

Defined in: packages/poml/base.tsx:147

Priority used when truncating globally. Lower numbers are dropped first.

Inherited from

PropsSyntaxBase.priority

selector?

optional selector: string

Defined in: packages/poml/components/webpage.tsx:15

sourcePath?

optional sourcePath: string

Defined in: packages/poml/base.tsx:136

Inherited from

PropsSyntaxBase.sourcePath

speaker?

optional speaker: Speaker

Defined in: packages/poml/base.tsx:127

Inherited from

PropsSyntaxBase.speaker

src?

optional src: string

Defined in: packages/poml/components/webpage.tsx:10

syntax?

optional syntax: string

Defined in: packages/poml/essentials.tsx:21

Inherited from

PropsSyntaxBase.syntax

tokenLimit?

optional tokenLimit: number

Defined in: packages/poml/base.tsx:145

Soft token limit before truncation is applied.

Inherited from

PropsSyntaxBase.tokenLimit

url?

optional url: string

Defined in: packages/poml/components/webpage.tsx:11

whiteSpace?

optional whiteSpace: "filter" | "pre" | "trim"

Defined in: packages/poml/base.tsx:140

Inherited from

PropsSyntaxBase.whiteSpace

writerOptions?

optional writerOptions: object

Defined in: packages/poml/base.tsx:139

Inherited from

PropsSyntaxBase.writerOptions

Variables

AiMessage()

const AiMessage: (props) => Element

Defined in: packages/poml/components/message.tsx:59

Wrap the contents in a AI message.

Parameters

props

children?

ReactNode

Returns

Element

See

Text for other props available.

Example

<ai-msg>Paris</ai-msg>

---

Caption()

const Caption: (props) => null | Element

Defined in: packages/poml/components/utils.tsx:72

Parameters

props

CaptionedParagraphProps

Returns

null | Element

---

CaptionedParagraph()

const CaptionedParagraph: (props) => Element

Defined in: packages/poml/components/utils.tsx:188

CaptionedParagraph (<cp> for short) creates a paragraph with a customized caption title.

Parameters

props

PropsWithChildren\<CaptionedParagraphProps>

Returns

Element

See

Paragraph for other props available.

Example

<cp caption="Constraints">
  <list>
    <item>Do not exceed 1000 tokens.</item>
    <item>Please use simple words.</item>
  </list>
</cp>

---

Conversation()

const Conversation: (props) => Element

Defined in: packages/poml/components/message.tsx:153

Display a conversation between system, human and AI.

Parameters

props

PropsWithChildren\<ConversationProps>

Returns

Element

Example

<conversation messages="{{[{ speaker: 'human', content: 'What is the capital of France?' }, { speaker: 'ai', content: 'Paris' }]}}" />

---

Document()

const Document: (props) => Element

Defined in: packages/poml/components/document.tsx:271

Displaying an external document like PDF, TXT or DOCX.

Parameters

props

DocumentProps

Returns

Element

See

Inline for other props available.

Example

To display a Word document without including the real multimedia:

<Document src="sample.docx" multimedia="false"/>

---

Example()

const Example: (props) => Element

Defined in: packages/poml/components/instructions.tsx:348

Example is useful for providing a context, helping the model to understand what kind of inputs and outputs are expected. It can also be used to demonstrate the desired output style, clarifying the structure, tone, or level of detail in the response.

Parameters

props

PropsWithChildren\<ExampleProps>

Returns

Element

See

Paragraph for other props available.

Example

<example>
  <input>What is the capital of France?</input>
  <output>Paris</output>
</example>

<task>Summarize the following passage in a single sentence.</task>
<example>
  <input caption="Passage">The sun provides energy for life on Earth through processes like photosynthesis.</input>
  <output caption="Summary">The sun is essential for energy and life processes on Earth.</output>
</example>

---

ExampleInput()

const ExampleInput: (props) => Element

Defined in: packages/poml/components/instructions.tsx:407

ExampleInput (<input>) is a paragraph that represents an example input. By default, it's spoken by a human speaker in a chat context, but you can manually specify the speaker.

Parameters

props

PropsWithChildren\<CustomizableCaptionParagraphProps>

Returns

Element

See

Paragraph for other props available.

Example

<input>What is the capital of France?</input>

When used with a template:

<input>What is the capital of {{country}}?</input>

---

ExampleOutput()

const ExampleOutput: (props) => Element

Defined in: packages/poml/components/instructions.tsx:462

ExampleOutput (<output>) is a paragraph that represents an example output. By default, it's spoken by a AI speaker in a chat context, but you can manually specify the speaker.

Parameters

props

PropsWithChildren\<CustomizableCaptionParagraphProps>

Returns

Element

See

Paragraph for other props available.

Example

<output>The capital of France is Paris.</output>

When used with a template:

<output>The capital of {{country}} is {{capital}}.</output>

---

ExampleSet()

const ExampleSet: (props) => Element

Defined in: packages/poml/components/instructions.tsx:284

Example set (<examples>) is a collection of examples that are usually presented in a list. With the example set, you can manage multiple examples under a single title and optionally an introducer, as well as the same chat format. You can also choose to use <example> purely without example set.

Parameters

props

PropsWithChildren\<ExampleSetProps>

Returns

Element

See

Paragraph for other props available.

Example

<examples chat={{true}}>
  <example>
    <input>What is the capital of France?</input>
    <output>Paris</output>
  </example>
  <example>
    <input>What is the capital of Germany?</input>
    <output>Berlin</output>
  </example>
</examples>

---

Folder()

const Folder: (props) => Element

Defined in: packages/poml/components/tree.tsx:339

Displays a directory structure as a tree.

Parameters

props

FolderProps

Returns

Element

Example

To display a directory structure with a filter for Python files:

<folder src="project_dir" filter=".*\.py$" maxDepth="3" />

---

Hint()

const Hint: (props) => Element

Defined in: packages/poml/components/instructions.tsx:188

Hint can be used anywhere in the prompt where you want to provide a helpful tip or explanation. It is usually a short and concise statement that guides the LLM in the right direction.

Parameters

props

PropsWithChildren\<CustomizableCaptionParagraphProps>

Returns

Element

See

Paragraph for other props available.

Example

<hint>Alice first purchased 4 apples and then 3 more, so she has 7 apples in total.</hint>

---

HumanMessage()

const HumanMessage: (props) => Element

Defined in: packages/poml/components/message.tsx:38

Wrap the contents in a user message.

Parameters

props

children?

ReactNode

Returns

Element

See

Text for other props available.

Example

<user-msg>What is the capital of France?</user-msg>

---

Introducer()

const Introducer: (props) => Element

Defined in: packages/poml/components/instructions.tsx:225

Introducer is a paragraph before a long paragraph (usually a list of examples, steps, or instructions). It serves as a context introducing what is expected to follow.

Parameters

props

PropsWithChildren\<CustomizableCaptionParagraphProps>

Returns

Element

See

Paragraph for other props available.

Example

<introducer>Here are some examples.</introducer>

---

MessageContent()

const MessageContent: (props) => undefined | Element

Defined in: packages/poml/components/message.tsx:83

Display a message content.

Parameters

props

PropsWithChildren\<MessageContentProps>

Returns

undefined | Element

Example

<msg-content content="What is the capital of France?" />

---

OutputFormat()

const OutputFormat: (props) => Element

Defined in: packages/poml/components/instructions.tsx:110

Output format deals with the format in which the model should provide the output. It can be a specific format such as JSON, XML, or CSV, or a general format such as a story, a diagram or steps of instructions. Please refrain from specifying too complex formats that the model may not be able to generate, such as a PDF file or a video.

Parameters

props

PropsWithChildren\<CustomizableCaptionParagraphProps>

Returns

Element

See

Paragraph for other props available.

Example

<output-format>Respond with a JSON without additional characters or punctuations.</output-format>

---

Question()

const Question: (props) => Element

Defined in: packages/poml/components/instructions.tsx:517

Question (<qa>) is actually a combination of a question and a prompt for the answer. It's usually used at the end of a prompt to ask a question. The question is followed by a prompt for answer (e.g., Answer:) to guide the model to respond.

Parameters

props

PropsWithChildren\<QuestionProps>

Returns

Element

See

Paragraph for other props available.

Example

<qa>What is the capital of France?</qa>

---

Role()

const Role: (props) => Element

Defined in: packages/poml/components/instructions.tsx:31

Specifies the role you want the language model to assume when responding. Defining a role provides the model with a perspective or context, such as a scientist, poet, child, or any other persona you choose.

Parameters

props

PropsWithChildren\<CustomizableCaptionParagraphProps>

Returns

Element

See

Paragraph for other props available.

Example

<role>You are a data scientist.</role>

---

StepwiseInstructions()

const StepwiseInstructions: (props) => Element

Defined in: packages/poml/components/instructions.tsx:152

StepwiseInstructions that elaborates the task by providing a list of steps or instructions. Each step should be concise and clear, and the list should be easy to follow.

Parameters

props

PropsWithChildren\<CustomizableCaptionParagraphProps>

Returns

Element

See

Paragraph for other props available.

Example

<stepwise-instructions>
  <list>
    <item>Interpret and rewrite user's query.</item>
    <item>Think of a plan to solve the query.</item>
    <item>Generate a response based on the plan.</item>
  </list>
</stepwise-instructions>

---

SystemMessage()

const SystemMessage: (props) => Element

Defined in: packages/poml/components/message.tsx:17

Wrap the contents in a system message.

Parameters

props

children?

ReactNode

Returns

Element

See

Text for other props available.

Example

<system-msg>Answer concisely.</system-msg>

---

Table()

const Table: (props) => undefined | Element

Defined in: packages/poml/components/table.tsx:387

Displaying a table with records and columns.

Parameters

props

TableProps

Returns

undefined | Element

See

Inline for other props available.

Example

<table records="{{[{ name: 'Alice', age: 20 }, { name: 'Bob', age: 30 }]}}" />

To import an excel file, and display the first 10 records in csv syntax:

<table src="data.xlsx" parser="excel" maxRecords="10" syntax="csv" />

---

Task()

const Task: (props) => Element

Defined in: packages/poml/components/instructions.tsx:76

Task represents the action you want the language model to perform. It is a directive or instruction that you want the model to follow. Task is usually not long, but rather a concise and clear statement. Users can also include a list of steps or instructions to complete the task.

Parameters

props

PropsWithChildren\<CustomizableCaptionParagraphProps>

Returns

Element

See

Paragraph for other props available.

Example

<task>Cook a recipe on how to prepare a beef dish.</task>

When including a list of steps:

<task>
  Planning a schedule for a travel.
  <list>
    <item>Decide on the destination and plan the duration.</item>
    <item>Find useful information about the destination.</item>
    <item>Write down the schedule for each day.</item>
  </list>
</task>

---

Tree()

const Tree: (props) => Element

Defined in: packages/poml/components/tree.tsx:205

Renders a tree structure in various formats.

Parameters

props

TreeProps

Returns

Element

Example

<Tree items={treeData} syntax="markdown" showContent={true} />

---

Webpage()

const Webpage: (props) => Element

Defined in: packages/poml/components/webpage.tsx:128

Displays content from a webpage.

Parameters

props

WebpageProps

Returns

Element

See

Inline for other props available.

Example

Display content from a URL:

<webpage url="https://example.com" />

Extract only specific content using a selector:

<webpage url="https://example.com" selector="main article" />

Convert HTML to structured POML components:

<webpage url="https://example.com" extractText="false" />

Functions

htmlToPoml()

htmlToPoml(element, $, options?): ReactElement

Defined in: packages/poml/components/document.tsx:114

Parameters

element

Cheerio\<any>

$

CheerioAPI

options?

DocumentProps

Returns

ReactElement

---

parsePythonStyleSlice()

parsePythonStyleSlice(slice, totalLength): [number, number]

Defined in: packages/poml/components/utils.tsx:229

Parameters

slice

string

totalLength

number

Returns

[number, number]

---

readDocx()

readDocx(dataBuffer, options?): Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

Defined in: packages/poml/components/document.tsx:166

Parameters

dataBuffer

Buffer

options?

DocumentProps

Returns

Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

---

readDocxFromPath()

readDocxFromPath(filePath, options?): Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

Defined in: packages/poml/components/document.tsx:175

Parameters

filePath

string

options?

DocumentProps

Returns

Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

---

readPdf()

readPdf(dataBuffer, options?): Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

Defined in: packages/poml/components/document.tsx:36

Parameters

dataBuffer

Buffer

options?

DocumentProps

Returns

Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

---

readPdfFromPath()

readPdfFromPath(filePath, options?): Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

Defined in: packages/poml/components/document.tsx:51

Parameters

filePath

string

options?

DocumentProps

Returns

Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

---

readTxt()

readTxt(dataBuffer, options?): Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

Defined in: packages/poml/components/document.tsx:183

Parameters

dataBuffer

Buffer

options?

DocumentProps

Returns

Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

---

readTxtFromPath()

readTxtFromPath(filePath, options?): Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

Defined in: packages/poml/components/document.tsx:191

Parameters

filePath

string

options?

DocumentProps

Returns

Promise\<ReactElement\<unknown, string | JSXElementConstructor\<any>>>

---

toRecordColumns()

toRecordColumns(props): RecordColumns

Defined in: packages/poml/components/table.tsx:248

Parameters

props

TableProps

Returns

RecordColumns