mokr.waiters.navigation
=======================

.. py:module:: mokr.waiters.navigation


Classes
-------

.. autoapisummary::

   mokr.waiters.navigation.NavigationWaiter


Module Contents
---------------

.. py:class:: NavigationWaiter(frame_manager: mokr.frame.FrameManager, frame: mokr.frame.Frame, timeout: int, wait_until: list[mokr.constants.LIFECYCLE_EVENTS] | mokr.constants.LIFECYCLE_EVENTS)

   Class to listen to a `mokr.frame.FrameManager` for specific navigation
   event(s) (`LIFECYCLE_EVENTS`) in the target `mokr.frame.Frame` for up
   to a given `timeout`. If all events not seen before timeout, raises
   a `MokrTimeoutError` exception.

   :param frame_manager: The `mokr.frame.FrameManager` to watch
                         for lifecycle events.
   :type frame_manager: FrameManager
   :param frame: The `mokr.frame.Frame` that seen events count toward.
   :type frame: Frame
   :param timeout: Tiem in milliseconds to wait for event.
   :type timeout: int
   :param wait_until: Either a
                      list of events or a single event to wait for.
   :type wait_until: list[LIFECYCLE_EVENTS] | LIFECYCLE_EVENTS


   .. py:method:: navigation_promise() -> Any

      Return the promise so errors can be handled externally.

      :returns: Navigation promise.
      :rtype: Any



   .. py:method:: cancel() -> None

      Stop this waiter, raise no errors.