mokr.waiters.navigation

Classes

NavigationWaiter

Class to listen to a mokr.frame.FrameManager for specific navigation

Module Contents

class mokr.waiters.navigation.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.

Parameters:

  • frame_manager (FrameManager) – The mokr.frame.FrameManager to watch for lifecycle events.

  • frame (Frame) – The mokr.frame.Frame that seen events count toward.

  • timeout (int) – Tiem in milliseconds to wait for event.

  • wait_until (list[LIFECYCLE_EVENTS] | LIFECYCLE_EVENTS) – Either a list of events or a single event to wait for.

navigation_promise() → Any

Return the promise so errors can be handled externally.

Returns:

Navigation promise.

Return type:

Any

cancel() → None

Stop this waiter, raise no errors.