platform-bible-utils
    Preparing search index...

    Type Alias UsjReaderWriterOptions

    Set of options to provide to UsjReaderWriter's constructor to customize how the reading and writing works

    type UsjReaderWriterOptions = {
        markersMap?: MarkersMap;
        shouldAllowInvisibleCharacters?: boolean;
    }
    Index

    Properties

    markersMap?: MarkersMap

    A map of all USFM/USX/USJ markers and some information about them. Used for translating between the formats

    Defaults to trying to use a built-in markers map that matches the version of the USJ passed in.

    Currently supported built-in USFM versions:

    • 3.0/3.0.x
    shouldAllowInvisibleCharacters?: boolean

    Whether the transformations should preserve invisible characters as in Paratext 9 (ScrText.Settings.AllowInvisibleChars).

    Defaults to false