Search


Search something to see results

CompareFunction

CompareFunction: (
    local: string,
    remote: string,
) => Change | Change[] | string | boolean

Function that will compare entire API responses and return a change or a list of changes in them.

It can either return a single Change object or an array with detailed information of the change. In case a string is returned, a change gets triggered with the string value set as the desc attribute. When returning true, a default Change object is created which triggers a refresh and in case of returning false, no refresh is triggered.

Type Declaration

    • (local: string, remote: string): Change | Change[] | string | boolean
    • Parameters

      • local: string
      • remote: string

      Returns Change | Change[] | string | boolean