Type Alias UsjSearchResult

Result of a search for text within a USJ object

type UsjSearchResult = {
    end: UsjNodeAndDocumentLocation<UsjTextContentLocation>;
    start: UsjNodeAndDocumentLocation<UsjTextContentLocation>;
    text: string;
}

Index

Properties

end start text

Properties

end

end: UsjNodeAndDocumentLocation<UsjTextContentLocation>

Ending location in the USJ document of the search result. The text is exclusive of this location, meaning this is the location right after the last character of the found text

start

start: UsjNodeAndDocumentLocation<UsjTextContentLocation>

Beginning location in the USJ document of the search result. The text is inclusive of this location, meaning this is the location of the first character of the found text

text

text: string

The matching Scripture text (not USFM string) that was found between the start and end locations

Type Alias UsjSearchResult

Index

Properties

Properties

end

start

text

Settings

On This Page