Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that evaluateScript() has specific needs #742

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/Driver/DriverInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,12 @@ public function executeScript($script);
*
* The "return" keyword is optional in the script passed as argument. Driver implementations
* must accept the expression both with and without the keyword.
* Multiline scripts must be wrapped in an immediately-invoked
* function expression.
* Examples of valid scripts:
* - '1 + 1'
* - 'return 1 + 1;'
* - '(function () {return 1 + 1;})()'
*
* @param string $script
*
Expand Down
8 changes: 8 additions & 0 deletions src/Session.php
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,14 @@ public function executeScript($script)
/**
* Execute JS in browser and return it's response.
*
* The "return" keyword is optional in the script passed as argument.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to have an actual example.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* Multiline scripts must be wrapped in an immediately-invoked
* function expression.
* Examples of valid scripts:
* - '1 + 1'
* - 'return 1 + 1;'
* - '(function () {return 1 + 1;})()'
*
* @param string $script javascript
*
* @return string
Expand Down