CheckResult | WebHare Platform SDK
WebHare Platform SDK
    Preparing search index...

    Type Alias CheckResult

    CheckResult: {
        isCritical?: boolean;
        jumpTo?: object | null;
        metadata?: object | null;
        scopes?: CheckScopes[];
        type: string;
    } & (
        | { messageText: string }
        | { messageTid: { params?: string[]; tid: string } }
    )

    Type declaration

    • OptionalisCritical?: boolean

      Is this a critical message?

    • OptionaljumpTo?: object | null
    • Optionalmetadata?: object | null

      Check specific metadata

    • Optionalscopes?: CheckScopes[]
    • type: string

      Check type, a modulescoped:name

    • { messageText: string }
      • messageText: string

        Textual message

    • { messageTid: { params?: string[]; tid: string } }
      • messageTid: { params?: string[]; tid: string }

        TID based message