Trevixal API
    Preparing search index...

    Interface WritingIssue

    interface WritingIssue {
        from: number;
        id: string;
        kind: WritingIssueKind;
        message: string;
        path: Path;
        rule?: string;
        suggestion?: string;
        text: string;
        to: number;
    }
    Index
    from id kind message path rule? suggestion? text to
    from: number

    Inline offsets within that block.

    id: string

    Identifies this issue among the report's, and is written onto the painted span as data-trevixal-issue so a hover card or a click menu can find its way from the DOM back here. Derived from the range and the kind rather than counted, so a re-check that finds the same problem in the same place produces the same id and an open popover stays pointed at it.

    kind: WritingIssueKind
    message: string
    path: Path

    Path of the textblock holding the range.

    rule?: string

    Grammar rule id, for grammar issues.

    suggestion?: string

    Replacement for the range, when the fix is mechanical.

    Readonlytext

    text: string

    The flagged text, so a fix can refuse to apply once the block has changed.

    to: number

    Settings
    Member Visibility

    On This Page
    Properties