Interface IEpubCfiPathNode

Describes a full parent path, range start or range end path.

interface IEpubCfiPathNode {
    complete: boolean;
    localPaths: IEpubCfiLocalPathNode[];
    offset: IEpubCfiOffsetNode;
    srcOffset?: number;
    type: PATH;
}

Hierarchy (View Summary)

IEpubCfiNode
- IEpubCfiPathNode

Properties

complete

complete: boolean

If this path was completely parsed to the end. Can be false if an unexpected token was found while parsing the path.

localPaths

localPaths: IEpubCfiLocalPathNode[]

The local paths that are part of this path.

offset

offset: IEpubCfiOffsetNode

The terminal offset of this path.

`Optional`srcOffset

srcOffset?: number

The character offset within the source EPUB CFI string corresponding to this node.

type

type: PATH

The type of EPUB CFI node.