Utility APIs

Random

warning Two calls to Random() may return the same number. DO NOT use it for uniqueness.

Parameters

$maxNumber

integer

maximum number

Return Value

integer

Random number between 0 and maxNumber

Modes Supported :

Raw Script

Sahi Pro Classic API :_random

Extract

This API helps extract specific content from strings.

Parameters

$str	string	String to find pattern in
$pattern	string	Regular expression as native regex (/a/) or as a string ("/a/")
$onlyGroups	boolean optional	if true, returns only the groups matched.

Return Value

string	Content from a string if there is only one matched pattern
array of strings	Array of matched pattern from the specified string

Modes Supported :

Raw Script

// Example:
// To get value "250" from "Rs. 250"
_extract("Rs. 250", "/Rs. (.*)/", true); // returns "250"
_extract("Rs. 250", "/Rs. (.*)/"); // returns an array ["Rs. 250", "250"]


// Multiple groups with and without onlyGroups
var $str = "The traffic light changed from red to green";
var $pattern = "/from (.*) to (.*)/";

var $extracted = _extract($str, $pattern);
// $extracted now has the overall match "from red to green" and the individual groups "red" and "green"
_assertEqual(["from red to green", "red", "green"], $extracted);

// Setting onlyGroups=true, we do not get back the overall match.
var $extracted = _extract($str, $pattern, true);
// $extracted now has only the individual groups "red" and "green"
_assertEqual(["red", "green"], $extracted);

Sahi Pro Classic API :_extract

Trim

Parameters

$arg

string|array of strings|two dimensional array of strings

String or 1-d or 2-d array.

Return Value

string	trimmed string if $arg is a string
array of strings	trimmed array if $arg is an array
two dimensional array of strings	trimmed 2 dimensional array if $arg is a 2 dimensional array

Modes Supported :

Raw Script

var $s = " sahi pro  ";
$s = _trim($s);
_assertEqual("sahi pro", $s);

var $arr = ["",,,"sahi", "pro",,,"",,];
$arr = _trim($arr);
_assertEqual("sahi", $arr[0]);
_assertEqual("pro", $arr[1]);
_assertEqual(2, $arr.length);

var $array2D = [[],[],[],["","",""],["abc", "xyz", "c"], ["1", "2", "3"], ["1", "2", "3"], ["1", "2", "3"], ["1", "2", "3"],[],[""],[]];
$array2D = _trim($array2D);
_assertEqual("xyz", $array2D[0][1]);
_assertEqual(5, $array2D.length);

Sahi Pro Classic API :_trim

To JSON

It converts a JSON object to String.

Example

Parameters

$object

JSON Object

JSON to convert to string.

Return Value

string

JSON string

Modes Supported :

Raw Script

var $libObj = {
  "name":"John Johnson",
  "street":"Oslo West 16",
  "age":33,
  "phone":"555 1234567"};
// Gives string corresponding to json object.
var $jsonString = _toJSON($libObj);

Sahi Pro Classic API :_toJSON

Encrypt

Example

Parameters

$password

string

password to be encrypted

Return Value

string

Encrypted password string

Modes Supported :

Raw Script

var $pass = _encrypt("secret");
_setPassword(_password("password"), $pass);

Sahi Pro Classic API :_encrypt

Get Session Id

Example

Parameters

$windowIdentifier

string optional

the windowIdentifier can be the window name, the window title, the window url or a regular expression of any of these.

Return Value

array of strings

Array of sessionId

Modes Supported :

Raw Script

var $sessionId = _getSessionId("Sahi Start");
$sessionId = _getSessionId("/Sahi/");
$sessionId = _getSessionId("/Sahi/[0]");
$sessionId = _getSessionId();

Sahi Pro Classic API :_getSessionId