Skip to content

Type Alias: Description

Description = string | readonly Description[] | {[key: string]: Description; }

A node in the description tree consumed by toDescription.

  • string - a text paragraph.
  • Description[] - a sequence of stacked blocks at the same level (no list markers). Plain text adjacent to a list (either direction) flushes together so the prose reads as a lead-in or trailing summary. Two text paragraphs, two adjacent lists, and anything touching a map get a blank-line break.
  • { bullets: [...] } / { numbered: [...] } - explicit list. A list of one bare string drops its marker (- / 1.); a list of one item with nested children keeps its marker as the visual anchor for the indented children.
  • any other object - headers map: each key becomes a Header: line followed by a blank line and the rendered value.