@opscogs/octools
    Preparing search index...

    Class Finding

    One conformance problem.

    rule is a stable snake_case identifier for the rule that fired, message explains it for a person, tool names the descriptor it concerns (null for a bare schema check), and path is a JSON pointer where that applies. Instances are frozen; build a changed copy with new Finding({ ...finding, tool: "name" }).

    Index
    constructor
    message path rule tool
    message: string

    Explains the problem for a person; not part of the contract.

    path: string | null

    JSON pointer to where the problem is, or null.

    rule: string

    Stable snake_case identifier of the rule that fired.

    tool: string | null

    The descriptor the finding concerns; null for a bare schema check.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties