platform-bible-utils
    Preparing search index...

    Type Alias UsjAttributeKeyLocation

    A JSONPath query to a specific point in an attribute key string in a MarkerObject or Usj. The property cannot be type or marker because these properties' keys have no representation in USFM. The property also cannot be any special attribute whose key doesn't have a text representation in USFM like default attribute, leading attribute, text content attribute

    To represent a location in an attribute's value, use UsjPropertyValueLocation.

    type UsjAttributeKeyLocation = {
        jsonPath: ContentJsonPath;
        keyName: string;
        keyOffset: number;
    }
    Index

    Properties

    jsonPath keyName keyOffset

    Properties

    jsonPath: ContentJsonPath

    JSON path to the marker whose attribute key the location is pointing to. The offset applies to this attribute's key string unless the attribute is an attribute marker in USFM.

    keyName: string

    Attribute name on the marker object whose key this location is pointing to.

    keyOffset: number

    The character index in the attribute's key string where this location is pointing.

    If the attribute is an attribute marker in USFM, the location is at this offset within the marker name for this attribute marker (for example, c's altnumber attribute has attribute marker ca, so its keyOffset applies to ca).

    If the attribute is not an attribute marker in USFM, the location is at this offset within the attribute's key string.

    Settings

    Member Visibility

    On This Page

    Properties