Function runRules

  • Synchronously run any pending rules tied to a specific schedule.

    (Note: "pending" rules are ones with at least one changed ancestor dependency; this doesn't mean they will actually do anything, since intermediate cached() function results might end up unchanged.)

    You should normally only need to call this when you need to force side-effects to occur within a specific synchronous timeframe, e.g. if rules need to be able to cancel a synchronous event or continue an IndexedDB transaction. (Otherwise, this is really only useful for testing.)

    Parameters

    • Optional scheduleFn: ((cb: (() => unknown)) => unknown)

      The scheduler used to create the rule factory you wish to run pending rules for. If not given, the default rule() factory is targeted.

        • (cb: (() => unknown)): unknown
        • Parameters

          • cb: (() => unknown)
              • (): unknown
              • Returns unknown

          Returns unknown

    Returns void