Utilities

Logging, waiting, time, random numbers, Base64 and HTTP requests. All three log levels are uploaded to the task log and show up in the console in real time.

Aperçu

·Three log levels — logd / logi / loge; the console shows debug in grey and errors in red
·randomInt / randomFloat / randomChoice add randomness to waits, taps and wording
·httpGet / httpPost never throw on failure and always return { ok, status, text, json, headers, error }

logd#

A debug log line: the details you look at while troubleshooting. It is uploaded too and shows in grey in the log panel.

typescript

logd(message: any): void;

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`message`	`any`	Oui	—	What to log. Objects are serialised to JSON; anything else is converted to a string.

Remarques

Keep it out of tight loops: the server keeps only the most recent part of each task's log, and noise pushes out what matters.

Exemple

javascript

logd(client.windowSize());

Voir aussi logi、loge

logi#

An info log line: which step the script reached and what it got.

typescript

logi(message: any): void;

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`message`	`any`	Oui	—	What to log. Objects are serialised to JSON; anything else is converted to a string.

Exemple

javascript

logi('step 1 done');

Voir aussi logd、loge

loge#

An error log line for failures. It is highlighted in red in the log panel.

typescript

loge(message: any): void;

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`message`	`any`	Oui	—	What to log. Objects are serialised to JSON; anything else is converted to a string.

Exemple

javascript

loge('the login button never appeared');

Voir aussi logi

setClickLog#

Turn click logging on or off. clickElement / clickImage / clickText record taps and misses in the task log by default; turn it off in busy loops so the log stays readable.

typescript

setClickLog(on: boolean): boolean;

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`on`	`boolean`	Oui	—	true to log, false to stay quiet.

Valeur de retour

Type	Description
`boolean`	The previous setting.

Remarques

Only these three functions are affected. Coordinate taps such as client.click never log.

Exemple

javascript

setClickLog(false);
for (var i = 0; i < 50; i++) {
  clickElement('label', 'Next', 1);
}
setClickLog(true);

Voir aussi clickElement、clickImage、clickText

sleep#

Wait for the given number of seconds. Returns immediately when the task is stopped.

typescript

sleep(seconds: number): void;

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`seconds`	`number`	Oui	—	How many seconds to wait; fractions are allowed.

Exemple

javascript

sleep(1.5);

Voir aussi randomFloat、shouldStop

getNowTimestamp#

The current Unix timestamp in seconds (an integer).

typescript

getNowTimestamp(): number;

Valeur de retour

Type	Description
`number`	The number of seconds since 1970-01-01 00:00:00 UTC.

Remarques

To measure elapsed time, store the timestamp at the start and subtract it later to get the seconds that passed. For milliseconds use Date.now().

Exemple

javascript

var start = getNowTimestamp();
sleep(2);
logi(getNowTimestamp() - start);

Voir aussi getNowTime、sleep

getNowTime#

The current time as 2026-10-01 14:05:09, in the device's local time zone.

typescript

getNowTime(): string;

Valeur de retour

Type	Description
`string`	"YYYY-MM-DD HH:MM:SS", with month, day, hour, minute and second zero-padded to two digits.

Remarques

For the date only take the first 10 characters: getNowTime().slice(0, 10); for hours and minutes only: getNowTime().slice(11, 16).

Exemple

javascript

logi('started at ' + getNowTime());

Voir aussi getNowTimestamp

randomInt#

A random integer with both ends included: randomInt(1, 6) is a die roll.

typescript

randomInt(min: number, max: number): number;

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`min`	`number`	Oui	—	The lower bound (inclusive).
`max`	`number`	Oui	—	The upper bound (inclusive).

Valeur de retour

Type	Description
`number`	An integer in [min, max]. Swapped bounds are handled.

Exemple

javascript

var n = randomInt(1, 6);

Voir aussi randomFloat、randomChoice

randomFloat#

A random decimal with both ends included, kept to 1 decimal place by default: randomFloat(1.5, 3) may give 1.5, 2.3 or 3. For example, pause for a random while between rounds: sleep(randomFloat(1.5, 3)).

typescript

randomFloat(min: number, max: number, digits?: number): number;

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`min`	`number`	Oui	—	The lower bound (inclusive).
`max`	`number`	Oui	—	The upper bound (inclusive).
`digits`	`number`	Non	`1`	How many decimal places to keep; an integer from 0 to 10.

Valeur de retour

Type	Description
`number`	A decimal in [min, max] with digits decimal places. Swapped bounds are handled.

Exceptions

Exception	Levée quand
`WDAError`INVALID_ARGUMENT	digits is not an integer from 0 to 10.

Remarques

When the range is too narrow to hold two different values at that precision, more places are kept automatically: at 1 decimal place randomFloat(0.45, 0.55) could only ever be 0.5, so it returns two-decimal values such as 0.47 or 0.52. The result always stays inside [min, max].
For values that need to be fine-grained, such as screen-ratio coordinates, pass the precision: client.click(randomFloat(0.3, 0.7, 3), randomFloat(0.4, 0.6, 3)). At 1 decimal place the tap could only land on 0.3, 0.4 and so on.

Exemple

javascript

sleep(randomFloat(1.5, 3));
var x = randomFloat(0.2, 0.8, 3);

Voir aussi randomInt、randomChoice、sleep

randomChoice#

Pick one item from an array at random, each with an equal chance.

typescript

randomChoice<T>(list: T[]): T | null;

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`list`	`T[]`	Oui	—	The candidates.

Valeur de retour

Type	Description
`T \| null`	The chosen item, or null for an empty array.

Exceptions

Exception	Levée quand
`WDAError`INVALID_ARGUMENT	The argument is not an array — for example, the candidates were passed as separate arguments.

Exemple

javascript

var greeting = randomChoice(['Hello', 'Good morning', 'Hi']);
logi(greeting);

Voir aussi randomInt、randomFloat

base64Encode#

Encode text as Base64 using UTF-8, so non-ASCII text survives.

typescript

base64Encode(text: string): string;

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`text`	`string`	Oui	—	The text.

Valeur de retour

Type	Description
`string`	The Base64 string.

Exemple

javascript

var b64 = base64Encode('hello');

Voir aussi base64Decode

base64Decode#

Decode Base64 back to text (UTF-8).

typescript

base64Decode(base64: string): string;

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`base64`	`string`	Oui	—	The Base64 string.

Valeur de retour

Type	Description
`string`	The decoded text.

Exemple

javascript

var text = base64Decode('aGVsbG8=');

Voir aussi base64Encode

httpGet#

Send a GET request.

typescript

httpGet(url: string, timeoutSec?: number, headers?: Record<string, string>): HttpResult;

type HttpResult = {
  ok: boolean;
  status: number;
  text: string;
  json: any;
  headers: Record<string, string>;
  error: string;
};

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`url`	`string`	Oui	—	The full address, starting with http:// or https://. Put query parameters in the address; non-ASCII text and spaces are encoded for you.
`timeoutSec`	`number`	Non	`15`	The longest wait, in seconds.
`headers`	`Record<string, string>`	Non	—	Request headers, for example { Authorization: 'Bearer xxx' }.

Valeur de retour

Type	Description
`HttpResult`	{ ok, status, text, json, headers, error }. ok means a 2xx status; status 0 means no response arrived (no network, timeout, task stopped) and error says why; json holds the parsed body when the response is JSON and null otherwise; header names are lowercase. Failures do not throw — check ok.

Exceptions

Exception	Levée quand
`WDAError`INVALID_ARGUMENT	The address does not start with http(s), the wait is not a number or exceeds 600, or the headers are not an object.

Exemple

javascript

var r = httpGet('https://api.example.com/items?page=1');
if (r.ok) {
  logi(r.json.items.length);
} else {
  loge(r.status + ' ' + r.error);
}

Voir aussi httpPost

httpPost#

Send a POST request. A string body is sent as-is ('a=1&b=2' goes out as a form, JSON text as JSON); an object is sent as JSON.

typescript

httpPost(url: string, body?: string | object, timeoutSec?: number, headers?: Record<string, string>): HttpResult;

Paramètres

Nom	Type	Obligatoire	Par défaut	Description
`url`	`string`	Oui	—	The full address, starting with http:// or https://. Put query parameters in the address; non-ASCII text and spaces are encoded for you.
`body`	`string \| object`	Non	—	The request body. A Content-Type header you set yourself is never overridden.
`timeoutSec`	`number`	Non	`15`	The longest wait, in seconds.
`headers`	`Record<string, string>`	Non	—	Request headers, for example { Authorization: 'Bearer xxx' }.

Valeur de retour

Type	Description
`HttpResult`	{ ok, status, text, json, headers, error }. ok means a 2xx status; status 0 means no response arrived (no network, timeout, task stopped) and error says why; json holds the parsed body when the response is JSON and null otherwise; header names are lowercase. Failures do not throw — check ok.

Exceptions

Exception	Levée quand
`WDAError`INVALID_ARGUMENT	The address does not start with http(s), the wait is not a number or exceeds 600, or the headers are not an object.

Remarques

Requests go to whatever address the script names; the script's author is responsible for where that data goes.

Exemple

javascript

var r = httpPost('https://example.com/report', 'device=' + getDeviceId() + '&status=ok');
if (!r.ok) {
  loge(r.status + ' ' + r.error);
}

Voir aussi httpGet