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

Comparing AnyEvent-WebDriver/README (file contents):
Revision 1.5 by root, Wed Aug 29 05:55:23 2018 UTC vs.
Revision 1.6 by root, Fri Aug 31 02:44:31 2018 UTC

     This module aims to implement the W3C WebDriver specification which is
     the standardised equivalent to the Selenium WebDriver API., which in
     turn aims at remotely controlling web browsers such as Firefox or
     Chromium.
-    At the time of this writing, it was so brand new that I ciould only get
+    At the time of this writing, it was so brand new that I could only get
-    "geckodriver" (For Firefox) to work, but that is expected to be fioxed
+    "geckodriver" (For Firefox) to work, but that is expected to be fixed
     very soon indeed.
     To make most of this module, or, in fact, to make any reasonable use of
     this module, you would need to refer to the W3C WebDriver
     recommendation, which can be found here
             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.
+        persistent => 1 | "undef"
+            If true (the default) then persistent connections will be used
+            for all requests, which assumes you have a reasonably stable
+            connection (such as to "localhost" :) and that the WebDriver has
+            a persistent timeout much higher than what AnyEvent::HTTP uses.
+            You can force connections to be closed for non-idempotent
+            requests by setting this to "undef".
     $al = $wd->actions
         Creates an action list associated with this WebDriver. See ACTION
         LISTS, below, for full details.
     $sessionstring = $wd->save_session
         (currently the session id and capabilities), not the endpoint
         information itself.
         The main use of this function is in conjunction with disabled
         "autodelete", to save a session to e.g., and restore it later. It
-        could presumably used for other applications, suhc as using the same
+        could presumably used for other applications, such as using the same
-        sssion from multiple processes and so on.
+        session from multiple processes and so on.
     $wd->load_session ($sessionstring)
     $wd->set_session ($sessionid, $capabilities)
         Starts using the given session, as identified by $sessionid.
         $capabilities should be the original session capabilities, although
         WebDriver object.
         On success, "$wd->{sid}" is set to the session ID, and
         "$wd->{capabilities}" is set to the returned capabilities.
-        Simple example of creatring a WebDriver object and a new session:
+        Simple example of creating a WebDriver object and a new session:
            my $wd = new AnyEvent::Selenium endpoint => "http://localhost:4545";
            $wd->new_session ({});
         Real-world example with capability negotiation:
                        "moz:firefoxOptions" => {
                           binary => "firefox/firefox",
                           args => ["-devtools"],
                           prefs => {
                              "dom.webnotifications.enabled" => \0,
+                             "dom.push.enabled" => \0,
                              "dom.disable_beforeunload" => \1,
                              "browser.link.open_newwindow" => 3,
                              "browser.link.open_newwindow.restrictions" => 0,
                              "dom.popup_allowed_events" => "",
                              "dom.disable_open_during_load" => \1,
     $handles = $wd->switch_to_parent_frame
         Switch to the parent frame.
     $rect = $wd->get_window_rect
-        Return the current window rect, e.g.:
+        Return the current window rect(angle), e.g.:
            $rect = $wd->get_window_rect
            => { height => 1040, width => 540, x => 0, y => 0 }
     $wd->set_window_rect ($rect)
-        Sets the window rect.
+        Sets the window rect(angle).
     $wd->maximize_window
     $wd->minimize_window
     $wd->fullscreen_window
         Changes the window size by either maximising, minimising or making
     $element = $wd->find_element ($locator_strategy, $selector)
         Finds the first element specified by the given selector and returns
         its element object. Raises an error when no element was found.
+        Examples showing all standard locator strategies:
            $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"]');
            => e.g. { "element-6066-11e4-a52e-4f735466cecf" => "decddca8-5986-4e1d-8c93-efe952505a5f" }
+        Same examples using aliases provided by this module:
+           $element = $wd->find_element (css => "body a");
+           $element = $wd->find_element (link => "Click Here For Porn");
+           $element = $wd->find_element (substr => "orn");
+           $element = $wd->find_element (tag => "input");
     $elements = $wd->find_elements ($locator_strategy, $selector)
         As above, but returns an arrayref of all found element objects.
     $element = $wd->find_element_from_element ($element, $locator_strategy,
            $wd->navigate_to ("https://duckduckgo.com/html");
            my $input = $wd->find_element ("css selector", 'input[type="text"]');
            $wd->actions
               ->move ($input, 40, 5, "touch1")
-              ->click;
+              ->click
-              ->key ("a");
+              ->key ("a")
-              ->key ("b");
+              ->key ("b")
-              ->pause (2000);
+              ->pause (2000)
               ->key ("\x{E007}")
-              ->pause (5000);
+              ->pause (5000)
               ->perform;
     $wd->release_actions
         Release all keys and pointer buttons currently depressed.
     By default, keyboard and mouse input sources are provided. You can
     create your own sources and use them when adding events. The above
     example could be more verbosely written like this:
        $wd->actions
+          ->source ("mouse", "pointer", pointerType => "mouse")
+          ->source ("kbd", "key")
           ->click (1, 100, "mouse")
-          ->type ("some text")
+          ->type ("some text", "kbd")
-          ->key ("{Enter}")
+          ->key ("{Enter}", "kbd")
           ->perform;
-    When you specify the event source expliticly it will switch the current
+    When you specify the event source explicitly it will switch the current
     "focus" for this class of device (all keyboards are in one class, all
     pointer-like devices such as mice/fingers/pens are in one class), so you
     don't have to specify the source for subsequent actions.
     When you use the sources "keyboard", "mouse", "touch1".."touch3", "pen"
         Create a new empty action list object. More often you would use the
         "$wd->action_list" method to create one that is already associated
         with a given web driver.
     $al = $al->source ($id, $type, key => value...)
-        The first time you call this with a givne ID, this defines the event
+        The first time you call this with a given ID, this defines the event
         source using the extra parameters. Subsequent calls merely switch
         the current source for its event class.
         It's not an error to define built-in sources (such as "keyboard" or
         "touch1") differently then the defaults.
         Example: define a new touch device called "fatfinger".
            $al->source (fatfinger => "pointer", pointerType => "touch");
-        Example: switchdefine a new touch device called "fatfinger".
+        Example: define a new touch device called "fatfinger".
            $al->source (fatfinger => "pointer", pointerType => "touch");
+        Example: switch default keyboard source to "kbd1", assuming it is of
+        "key" class.
+           $al->source ("kbd1");
     $al = $al->pause ($duration)
         Creates a pause with the given duration. Makes sure that time
         progresses in any case, even when $duration is 0.
         Convenience method to simulate a series of key press and release
         events for the keys in $string. There is no syntax for special keys,
         everything will be typed "as-is" if possible.
     $al->perform ($wd)
-        Finaluses and compiles the list, if not done yet, and calls
+        Finalises and compiles the list, if not done yet, and calls
         "$wd->perform" with it.
         If $wd is undef, and the action list was created using the
         "$wd->actions" method, then perform it against that WebDriver
         object.

Diff Legend

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

Comparing AnyEvent-WebDriver/README (file contents): Revision 1.5 by root, Wed Aug 29 05:55:23 2018 UTC vs. Revision 1.6 by root, Fri Aug 31 02:44:31 2018 UTC

Diff Legend

Comparing AnyEvent-WebDriver/README (file contents):
Revision 1.5 by root, Wed Aug 29 05:55:23 2018 UTC vs.
Revision 1.6 by root, Fri Aug 31 02:44:31 2018 UTC