platform-bible-utils
    Preparing search index...

    Type Alias UsjSearchOptions

    Options controlling how IUsjReaderWriter.search performs its search

    type UsjSearchOptions = {
        markerStylesToInclude?: Set<string>;
        normalizationForm?: "NFD";
    }
    Index

    Properties

    markerStylesToInclude? normalizationForm?

    Properties

    markerStylesToInclude?: Set<string>

    Optional set of marker styles (e.g., 'p', 'q1', 'nd') to include in the search. When provided, only text within markers whose style is in this set will be searched. Text inside markers not in this set (e.g., footnotes, cross-references) will be excluded. When omitted, all text is searched.

    normalizationForm?: "NFD"

    When 'NFD', the concatenated text is normalized to NFD before the regex is applied, and match positions are mapped back to the original string. This is required for correct ignoreDiacritics behaviour on NFC source text: a pre-composed character such as é (U+00E9) will not match e[combining]* unless the text is first decomposed. Returned text values are always slices of the original (non-NFD) string.

    Settings

    Member Visibility

    On This Page

    Properties