Skip to Content
Mika Scraper 1.1.1 is released ๐ŸŽ‰
๐Ÿ• MIKA INTERFACEInterface: PoemSuccess

Interface: PoemSuccess

Defined in: src/poem/poem-generator.ts:42

The PoemSuccess interface is returned when the poem generation operation is successful.

Properties

status

  • Type: boolean
  • Value: true

Defined in: src/poem/poem-generator.ts:43

Indicates the success of the poem generation process.

result

  • Type: string

Defined in: src/poem/poem-generator.ts:44

Contains the generated poem as a string. This property holds the actual text output of the poem after a successful generation.

Example

const poem: PoemSuccess = { status: true, result: "The waves crash with a gentle sigh,\nAs stars twinkle in the velvet sky." };

Diagram: Mika Scraper

Last updated on