platform-bible-utils
    Preparing search index...

    Type Alias UsjVerseRefBookLocation<TDocumentLocation>

    A verse ref and a location in USJ space that point to a specific location in USJ. The location in USJ space starts from the start of the book specified in the verse ref. The rest of the verse ref is meaningless and can be disregarded.

    type UsjVerseRefBookLocation<
        TDocumentLocation extends UsjDocumentLocation = UsjDocumentLocation,
    > = {
        documentLocation: TDocumentLocation;
        granularity: "book";
        verseRef: SerializedVerseRef;
    }

    Type Parameters

    Index

    Properties

    documentLocation: TDocumentLocation

    USJ document location specifying where in the book the location is pointing to

    granularity: "book"

    Specifies which part of the verse reference the document location is relative to:

    • book = document location is specified relative to the start of the book. The first content entry of the top-level USJ marker is the id marker of the book

    • chapter = document location is specified relative to the start of the chapter in the specified book. If the chapter number is 1, the first content entry of the top-level USJ marker is the id marker of the book because the intro content before chapter 1 is part of chapter 1. If the chapter number is greater than 1, the first content entry of the top-level USJ marker is the c marker of the chapter

      • Note: this is likely to be the case with peripheral books as well, but these books have periph markers between id and chapters, so this may need to be revised when peripheral books are more fully supported

    Defaults to 'chapter' (see UsjVerseRefChapterLocation)

    verseRef: SerializedVerseRef

    Verse reference indicating which book the document location is in