Skip to main content

Interface: VerseBlock

Defined in: Data/Text/VerseFormatting.ts:102

Properties of the verse as a whole, rather than of a range of words. Every field is optional; the object is omitted entirely when nothing applies.

Properties​

heading?​

readonly optional heading?: string

Defined in: Data/Text/VerseFormatting.ts:108

Superscription or section heading attached to this verse. USFM \d / \s.

heading_kind?​

readonly optional heading_kind?: HeadingKind

Defined in: Data/Text/VerseFormatting.ts:117

Which kind of heading heading is. One USFM marker cannot express both: \d is specifically a psalm/Hebrew descriptive title, so emitting it for a section heading like "The Beatitudes" produces invalid USFM.

Omitted when unknown — consumers default to 'section'. A module converted from v1 HTML generally will not have it, since <b> was used ambiguously for both.

paragraph_start?​

readonly optional paragraph_start?: boolean

Defined in: Data/Text/VerseFormatting.ts:104

This verse begins a new paragraph. USFM \p.

poetry_level?​

readonly optional poetry_level?: PoetryLevel

Defined in: Data/Text/VerseFormatting.ts:106

Poetry indent level 1–3. Omitted for prose. USFM \q1–\q3.

selah?​

readonly optional selah?: boolean

Defined in: Data/Text/VerseFormatting.ts:119

The verse carries a Selah / musical direction. USFM \qs.