[ViewVC] Diff of: cvs/AnyEvent-WebDriver/README

Comparing AnyEvent-WebDriver/README (file contents):
Revision 1.2 by root, Tue Aug 28 22:59:53 2018 UTC vs.
Revision 1.3 by root, Tue Aug 28 23:33:10 2018 UTC

        https://w3c.github.io/webdriver/
   CREATING WEBDRIVER OBJECTS
     new AnyEvent::WebDriver key => value...
-        Create a new WebDriver object. Example for a remote webdriver
+        Create a new WebDriver object. Example for a remote WebDriver
         connection (the only type supported at the moment):
            my $wd = new AnyEvent::WebDriver host => "localhost", port => 4444;
         Supported keys are:
         autodelete => $boolean
             If true (the default), then automatically execute
             "delete_session" when the WebDriver object is destroyed with an
             active session. IF set to a false value, then the session will
             continue to exist.
+        timeout => $seconds
+            The HTTP timeout, in (fractional) seconds (default: 300, but
+            this will likely drastically reduce). This timeout is reset on
+            any activity, so it is not an overall request timeout. Also,
+            individual requests might extend this timeout if they are known
+            to take longer.
   SIMPLIFIED API
     This section documents the simplified API, which is really just a very
     thin wrapper around the WebDriver protocol commands. They all block
     (using AnyEvent condvars) the caller until the result is available, so
     must not be called from an event loop callback - see "EVENT BASED API"
     for an alternative.
-    The method names are preetty much taken directly from the W3C WebDriver
+    The method names are pretty much taken directly from the W3C WebDriver
     specification, e.g. the request documented in the "Get All Cookies"
     section is implemented via the "get_all_cookies" method.
-    The order is the same as in the WebDriver draft at the tiome of this
+    The order is the same as in the WebDriver draft at the time of this
     writing, and only minimal massaging is done to request parameters and
     results.
    SESSIONS
     $wd->new_session ({ key => value... })
-        Try to connect to a webdriver and initialize session with a "new
+        Try to connect to the WebDriver and initialize a new session with a
-        session" command, passing the given key-value pairs as value (e.g.
+        "new session" command, passing the given key-value pairs as value
-        "capabilities").
+        (e.g. "capabilities").
         No session-dependent methods must be called before this function
-        returns successfully.
+        returns successfully, and only one session can be created per
+        WebDriver object.
-        On success, "$wd->{sid}" is set to the session id, and
+        On success, "$wd->{sid}" is set to the session ID, and
         "$wd->{capabilities}" is set to the returned capabilities.
-           my $wd = new AnyEvent::Selenium host => "localhost", port => 4545;
+           my $wd = new AnyEvent::Selenium endpoint => "http://localhost:4545";
            $wd->new_session ({
               capabilities => {
                  pageLoadStrategy => "normal",
               }.
     $timeouts = $wd->get_timeouts
         Get the current timeouts, e.g.:
            my $timeouts = $wd->get_timeouts;
-           # { implicit => 0, pageLoad => 300000, script => 30000 }
+           => { implicit => 0, pageLoad => 300000, script => 30000 }
     $wd->set_timeouts ($timeouts)
         Sets one or more timeouts, e.g.:
            $wd->set_timeouts ({ script => 60000 });
    NAVIGATION
     $wd->navigate_to ($url)
         Navigates to the specified URL.
     $url = $wd->get_current_url
-        Queries the czurrent page URL as set by "navigate_to".
+        Queries the current page URL as set by "navigate_to".
     $wd->back
         The equivalent of pressing "back" in the browser.
     $wd->forward
     $handles = $wd->get_window_handles
         Return the current window handles as an array-ref of handle IDs.
     $handles = $wd->switch_to_frame ($frame)
-        Switch to the given frame.
+        Switch to the given frame identified by $frame, which must be either
+        "undef" to go back to the top-level browsing context, an integer to
+        select the nth subframe, or an element object (as e.g. returned by
+        the "element_object" method.
     $handles = $wd->switch_to_parent_frame
         Switch to the parent frame.
     $rect = $wd->get_window_rect
         Return the current window rect, e.g.:
            $rect = $wd->get_window_rect
-           # { height => 1040, width => 540, x => 0, y => 0 }
+           => { height => 1040, width => 540, x => 0, y => 0 }
     $wd->set_window_rect ($rect)
         Sets the window rect.
     $wd->maximize_window
     $wd->minimize_window
     $wd->fullscreen_window
-        Changes the window size by eithe3r maximising, minimising or making
+        Changes the window size by either maximising, minimising or making
-        it fullscreen. In my experience, this might timeout if no window
+        it fullscreen. In my experience, this will timeout if no window
         manager is running.
    ELEMENT RETRIEVAL
     $element_id = $wd->find_element ($location_strategy, $selector)
         Finds the first element specified by the given selector and returns
-        its web element id (the strong, not the object from the protocol).
+        its web element ID (the strong, not the object from the protocol).
         Raises an error when no element was found.
            $element = $wd->find_element ("css selector" => "body a");
            $element = $wd->find_element ("link text" => "Click Here For Porn");
            $element = $wd->find_element ("partial link text" => "orn");
            $element = $wd->find_element ("tag name" => "input");
            $element = $wd->find_element ("xpath" => '//input[@type="text"]');
-           # "decddca8-5986-4e1d-8c93-efe952505a5f"
+           => e.g. "decddca8-5986-4e1d-8c93-efe952505a5f"
     $element_ids = $wd->find_elements ($location_strategy, $selector)
         As above, but returns an arrayref of all found element IDs.
     $element_id = $wd->find_element_from_element ($element_id,
     $string = $wd->get_element_property ($element_id, $name)
         Returns the value of the given property.
     $string = $wd->get_element_css_value ($element_id, $name)
-        Returns the value of the given css value.
+        Returns the value of the given CSS value.
     $string = $wd->get_element_text ($element_id)
         Returns the (rendered) text content of the given element.
     $string = $wd->get_element_tag_name ($element_id)
         Returns the tag of the given element.
     $rect = $wd->get_element_rect ($element_id)
-        Returns the element rect of the given element.
+        Returns the element rect(angle) of the given element.
     $bool = $wd->is_element_enabled
         Returns whether the element is enabled or not.
    ELEMENT INTERACTION
     $text = $wd->send_alert_text
         Fills in the user prompt with the given text.
    SCREEN CAPTURE
     $wd->take_screenshot
-        Create a screenshot, returning it as a PNG image in a data url.
+        Create a screenshot, returning it as a PNG image in a "data:" URL.
     $wd->take_element_screenshot ($element_id)
         Accept a simple dialog, if present.
   HELPER METHODS
+    $object = AnyEvent::WebDriver->element_object ($element_id)
     $object = $wd->element_object ($element_id)
-        Encoding element ids in data structures is done by represetning them
+        Encoding element IDs in data structures is done by representing them
-        as an object with a special key and the element id as value. This
+        as an object with a special key and the element ID as value. This
         helper method does this for you.
   EVENT BASED API
     This module wouldn't be a good AnyEvent citizen if it didn't have a true
     event-based API.
        $cv->recv;
     While the blocking methods "croak" on errors, the callback-based ones
     all pass two values to the callback, $status and $res, where $status is
-    the HTTP status code (200 for successful requests, typically 4xx ot 5xx
+    the HTTP status code (200 for successful requests, typically 4xx or 5xx
     for errors), and $res is the value of the "value" key in the JSON
     response object.
     Other than that, the underscore variants and the blocking variants are
     identical.
   LOW LEVEL API
-    All the simplfiied API methods are very thin wrappers around WebDriver
+    All the simplified API methods are very thin wrappers around WebDriver
-    commands of the same name. Theyx are all implemented in terms of the
+    commands of the same name. They are all implemented in terms of the
     low-level methods ("req", "get", "post" and "delete"), which exists in
     blocking and callback-based variants ("req_", "get_", "post_" and
     "delete_").
     Examples are after the function descriptions.
     Example: call "find_elements" to find all "IMG" elements, stripping the
     returned element objects to only return the element ID strings:
        my $elems = $wd->post (elements => { using => "css selector", value => "img" });
-       # yes, the W3C found an interetsing way around the typelessness of JSON
+       # yes, the W3C found an interesting way around the typelessness of JSON
        $_ = $_->{"element-6066-11e4-a52e-4f735466cecf"}
           for @$elems;
 HISTORY
     This module was unintentionally created (it started inside some quickly

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent-WebDriver/README (file contents): Revision 1.2 by root, Tue Aug 28 22:59:53 2018 UTC vs. Revision 1.3 by root, Tue Aug 28 23:33:10 2018 UTC

Diff Legend

Comparing AnyEvent-WebDriver/README (file contents):
Revision 1.2 by root, Tue Aug 28 22:59:53 2018 UTC vs.
Revision 1.3 by root, Tue Aug 28 23:33:10 2018 UTC