Skip to main content

Interface: VerseLink

Defined in: Data/Models/User/UserNote.ts:203

Verse link attached to a note.

v1 COMPAT — this is the shape of the legacy note_verse_link table. Module Format v2 replaces it with the unified verse_link table (source_type='note') and VerseLinkRecord (Models/Common/VerseLinkRecord). UserNoteRepository reads and writes whichever table the connected user database has, and always presents the result in this shape so consumers — including @bible/desktop, which imports VerseLink from @bible/core — keep working.

Pass-2 follow-up: retire this interface in favour of VerseLinkRecord. That is a breaking change to the published @bible/core surface, so it is deliberately deferred.

wordStart / wordEnd are 0-based inclusive word offsets (WS-5); they have no column in the unified table and round-trip through metadata there.

Properties

linkId?

optional linkId?: number

Defined in: Data/Models/User/UserNote.ts:204


linkType

linkType: "reference" | "annotation" | "primary_passage"

Defined in: Data/Models/User/UserNote.ts:208


metadata?

optional metadata?: Metadata

Defined in: Data/Models/User/UserNote.ts:211


noteId

noteId: number

Defined in: Data/Models/User/UserNote.ts:205


verseIdEnd?

optional verseIdEnd?: number

Defined in: Data/Models/User/UserNote.ts:207


verseIdStart

verseIdStart: number

Defined in: Data/Models/User/UserNote.ts:206


wordEnd?

optional wordEnd?: number

Defined in: Data/Models/User/UserNote.ts:210


wordStart?

optional wordStart?: number

Defined in: Data/Models/User/UserNote.ts:209