API リファレンス

$browser.actions().sendKeys("synthetic").perform();

パラメーター	タイプ	説明
RETURN	Actions	このインスタンスの新規アクション・シーケンス。
options	Object	「アクション」 シーケンスの構成オプション。

例 1: クリックするには、以下のコードを使用します。

const element = await $browser.waitForAndFindElement(by, timeout);
$browser.actions().move({origin: element}).press().release().perform();

例 2: ブラウザー・エレメントの上にマウスを移動するには、以下のコードを使用します。

const element = await $browser.waitForAndFindElement(by, timeout);
$browser.actions().move({origin: element, duration: 2000}).perform();

旧 mouseMove 機能と互換性を持たせるには、以下のコマンドを使用します。

$browser.actions().mouseMove(element).perform();

例 3: 鍵を送信するには、以下のコードを実行します。

await $browser.get("http://www.bing.com");
await $browser.actions().sendKeys("synthetic").perform();

$browser.addHeader(key: string, val: string): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	戻り値は promise です。
key	string	HTTP ヘッダー名。
val	string	HTTP ヘッダーの値。

await $browser.addHeader(
  "User-Agent",
  "Mozilla/5.0 (iPhone; CPU OS 10_15_5 (Ergänzendes Update) like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.1.1 Mobile/14E304 Safari/605.1.15"
);

await $browser.get("https://www.yahoo.com/");
await $browser.takeScreenshot();

await $browser.addHeader(
  "User-Agent",
  "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.16; rv:86.0) Gecko/20100101 Firefox/86.0"
);

await $browser.get("https://www.yahoo.com/");
await $browser.takeScreenshot();

$browser.addHeaders(headers: { [key: string]: string }): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	戻り値は promise です。
headers	{ [key: string]: string }	HTTPヘッダー

await $browser.addHeaders({
  key1: "val1",
  key2: "val2",
});

$browser.addHostnamesToDenylist(hostnameArr: string[]): Promise<void>

$browser.addHostnamesToBlacklist(hostnameArr: string[]): Promise<void>

パラメーター	タイプ	説明
RETURN	Promise<void>	戻り値は promise です。
hostnameArr	string[]	突き合わせるホスト名、およびワイルドカードをサポートするホスト名

await $browser.addHostnamesToDenylist(["*.css", "*.png"]);
await $browser.addHostnamesToAllowlist(["*"]);

$browser.addHostnamesToAllowlist(hostnameArr: string[]): Promise<void>

$browser.addHostnamesToWhitelist(hostnameArr: string[]): Promise<void>

パラメーター	タイプ	説明
RETURN	Promise<void>	戻り値は promise です。
hostnameArr	string[]	突き合わせるホスト名。ワイルドカードをサポートします。

await $browser.addHostnamesToDenylist(["*.css", "*.png"]);
await $browser.addHostnamesToAllowlist(["*"]);

$browser.addHostnameToDenylist(hostname: string): Promise<void>

$browser.addHostnameToBlacklist(hostname: string): Promise<void>

パラメーター	タイプ	説明
RETURN	Promise<void>	戻り値は promise です。
hostname	string	突き合わせるホスト名、およびワイルドカードをサポートするホスト名

await $browser.addHostnameToDenylist(`*.css`);
await $browser.addHostnameToAllowlist(`*`);

$browser.addHostnameToAllowlist(hostname: string): Promise<void>

$browser.addHostnameToWhitelist(hostname: string): Promise<void>

パラメーター	タイプ	説明
RETURN	Promise<void>	戻り値は promise です。
hostname	string	突き合わせるホスト名。ワイルドカードをサポートします。

await $browser.addHostnameToDenylist(`*.css`);
await $browser.addHostnameToAllowlist(`*`);

$browser.clearProxy(): Promise<void>;

$browser.deleteHeader(key: string): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	このコマンドの完了時に解決される promise。
key	string	HTTP ヘッダー名。

await $browser.addHeader('header1-xxx', 'abcd');
await $browser.addHeaders({
    key1: 'val1',
    key2: 'val2',
});
await $browser.deleteHeaders(['key1']);

await $browser.get(`http://localhost:${devport}/header-test`);
let userHeaders: Map<string, any>  = $browser.getHeaders();
console.log("User customized headers: ", [...userHeaders]);
expect(userHeaders.size).toEqual(2);

$browser.deleteHeaders: (header: string[]) => Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	このコマンドの完了時に解決される promise。
header	string[]	HTTP ヘッダー名。

await $browser.addHeader('header1-xxx', 'abcd');
await $browser.addHeaders({
    key1: 'val1',
    key2: 'val2',
});
await $browser.deleteHeaders(['key1']);

await $browser.get(`http://localhost:${devport}/header-test`);
let userHeaders: Map<string, any>  = $browser.getHeaders();
console.log("User customized headers: ", [...userHeaders]);
expect(userHeaders.size).toEqual(2);

$browser.deleteHostnameFromDenylist(hostname: string): Promise<void>;

$browser.deleteHostnameFromBlacklist(hostname: string): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	戻り値は promise です。
hostname	string	突き合わせるホスト名。ワイルドカードをサポートします。

$browser.deleteHostnameFromAllowlist(hostname: string): Promise<void>;

$browser.deleteHostnameFromWhitelist(hostname: string): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	戻り値は promise です。
hostname	string	突き合わせるホスト名。ワイルドカードをサポートします。

$browser.deleteHostnamesFromDenylist(hostnameArr: string[]): Promise<void>

$browser.deleteHostnamesFromBlacklist(hostnameArr: string[]): Promise<void>

パラメーター	タイプ	説明
RETURN	Promise<void>	戻り値は promise です。
hostnameArr	string[]	突き合わせるホスト名。ワイルドカードをサポートします。

$browser.deleteHostnamesFromAllowlist(hostnameArr: string[]): Promise<void>

$browser.deleteHostnamesFromWhitelist(hostnameArr: string[]): Promise<void>

パラメーター	タイプ	説明
RETURN	Promise<void>	戻り値は promise です。
hostnameArr	string[]	突き合わせるホスト名。ワイルドカードをサポートします。

$browser.$$(selector);

名前	タイプ	説明
RETURN	Promise<WebElement[]>	戻り値は、 WebElementsの配列を使用して解決される promise です。
selector	String, Function	特定のエレメントをフェッチするための Selector 関数または JavaScript 関数。

index.html ファイルは以下のとおりです。

<ul id="menu">
  <li><a href="/">Home</a></li>
  <li><a href="/">Developer Guide</a></li>
  <li><a href="/">API</a></li>
  <li><a href="/">Contribute</a></li>
</ul>

$$ を使用して、以下のようにエレメントを検索します。

test("should get text a menu link", async () => {
  const menu = (await $browser.$$("#menu"))[0];
  const li = await menu.$$("li");

  console.log(await li[2].$("a").getText()); // outputs: "API"
});

test("should get text a menu link - JS Function", async () => {
  const text = (
    await $browser.$$(function () {
      // Arrow function is not allowed here.
      return document.querySelectorAll("#menu"); // Element[]
    })
  )[0];

  const li3Text = await (await text.$$("li"))[2].$("a").getText();
  console.log(li3Text); // outputs: "API"
});

$browser.$(selector): WebElementPromise;

名前	タイプ	説明
RETURN	WebElementPromise	戻り値は WebElementPromise です。
selector	String, Function	複数のエレメントをフェッチするためのセレクターまたは JavaScript 関数。

index.html ファイルは以下のとおりです。

<ul id="menu">
  <li><a href="/">Home</a></li>
  <li><a href="/">Developer Guide</a></li>
  <li><a href="/">API</a></li>
  <li><a href="/">Contribute</a></li>
</ul>

次のように $を使用してエレメントを検索します。

test("should get text a menu link", async () => {
  const text = await $browser.$("#menu").$$("li");
  console.log(await text[2].$("a").getText()); // outputs: "API"
});

test("should get text a menu link - JS Function", async () => {
  const text = await $browser.$(function () {
      // Arrow function is not allowed here.
      return document.querySelector("#menu"); // Element
    }).$$("li");

  console.log(text.$$("li")[2].$("a").getText()); // outputs: "API"
});

$browser.execute(command) => Promise<T>

Promise<T> は、コマンド結果で解決される promise です。

パラメーター	タイプ	説明
command	Command	スケジュールするコマンド

$browser.executeAsyncScript<T>(script: string|Function, ...var_args: any[]): Promise<T>;

パラメーター	タイプ	説明
RETURN	Promise.<T>	スクリプトの戻り値を使用して解決される promise。
script	string, Function	実行するスクリプト。
...args	*	スクリプトに渡される引数です。

例 1: 現在選択されているウィンドウと同期化されたスリープを実行するには、以下の例に示すようにコマンドを使用します。

const start = new Date().getTime();
$browser.executeAsyncScript(
    "window.setTimeout(arguments[arguments.length - 1], 500);"
  ).then(function () {
    console.log("Elapsed time: " + (new Date().getTime() - start) + " ms");
  });

例 2: テストを Ajax アプリケーションと同期するには、以下の例に示すようにコマンドを使用します。

const button = $browser.$("#compose-button");
button.click();
$browser.executeAsyncScript(
  "var callback = arguments[arguments.length - 1];" +
    "mailClient.getComposeWindowWidget().onload(callback);"
);
$browser.switchTo().frame("composeWidget");
$browser.$("#to").sendKeys("dog@example.com");

例 3: XMLHttpRequest を注入して結果を待機するには、以下のコマンドを使用します。 この例では、注入スクリプトは関数リテラルで指定されています。 このフォーマットを使用すると、関数は注入のためにストリングに変換されます。 そのため、この関数は、テスト対象ページのスコープで定義されていないシンボルを参照してはなりません。

$browser.executeAsyncScript(function () {
    var callback = arguments[arguments.length - 1];
    var xhr = new XMLHttpRequest();
    xhr.open("GET", "/resource/data.json", true);
    xhr.onreadystatechange = function () {
      if (xhr.readyState == 4) {
        callback(xhr.responseText);
      }
    };
    xhr.send("");
  }).then(function (str) {
    console.log(JSON.parse(str)["food"]);
  });

$browser.executeScript<T>(script: string|Function, ...var_args: any[]): Promise<T>;

パラメーター	タイプ	説明
RETURN	Promise.<T>	スクリプトの戻り値を使用して解決される promise。
script	string, Function	実行するスクリプト。
...args	*	スクリプトに渡される引数です。

$browser.findElement(locator: Locator): WebElementPromise;

パラメーター	タイプ	説明
RETURN	WebElementPromise	見つかったエレメントに対してコマンドを発行するために使用できる WebElement 。 エレメントが見つからない場合、エレメントは無効になり、スケジュールされているすべてのコマンドが停止します。
locator	By , function	使用するロケーター。

この機能を使用して、ページ上にエレメントが存在するかどうかをテストしてはなりません。 その代わりに、 findElements を使用する必要があります：

$browser.findElements($driver.By.id("foo"))
  .then((found) => console.log("Element found? %s", !!found.length));

エレメントの検索基準を定義するには、 webdriver.By 名前空間内のいずれかのファクトリーを使用するか、短時間の webdriver.By.Hash オブジェクトとして使用します。 例えば、以下の 2 つのステートメントは同等です。

var e1 = $browser.findElement($driver.By.id("foo"));
var e2 = $browser.findElement({ id: "foo" });

また、このインスタンスを引数として受け取り、 WebElement、または WebElement で解決されるPromiseを返すカスタムロケーター関数を指定することもできます。 返されたPromiseが WebElements, の配列で解決された場合、 WebDriver は最初の要素を使用します。 例えば、ページ上の最初の可視リンクを検索するには、以下のコマンドを使用できます。

var link = $browser.findElement(firstVisibleLink);

function firstVisibleLink(driver) {
  var links = driver.findElements(By.tagName("a"));
  return promise.filter(links, function (link) {
    return link.isDisplayed();
  });
}

$browser.findElements(locator: Locator): Promise<WebElement[]>;

パラメーター	タイプ	説明
RETURN	Promise <WebElement[ ]>	WebElementsの配列を使用して解決される promise。
locator	By, function	使用するロケーター。

$browser.generateTOTPToken(key: string, options?: TOTPOptions): string;

パラメーター	タイプ	説明
RETURN	string	時刻ベースのワンタイム・パスワード (TOTP) トークン
key	string	TOTP キー、 base32 ストリング
options	Object,undefined	オプション: オプション設定 (例: {digits: 8, algorithm: "SHA-512", period: 60})。 デフォルト設定は {digits: 6, algorithm: "SHA-1", period: 30} です。

例 1: TOTP トークンを生成し、ブラウザー・スクリプト・テストで 2 要素認証を使用してログインするには、以下のようにします。

await $browser.waitForAndFindElement($driver.By.id("password"), 15000);

let totp_token = $browser.generateTOTPToken($secure.totpKey);

await $browser.findElement($driver.By.id("password")).then((element) => {
  return element.clear().then(() => {
    return element.sendKeys(totp_token);
  });
});

例 2: Selenium SIDE スクリプト・テストで TOTP トークンを生成するには、以下のようにします。

{
  "id": "ec51296b-4d16-4167-ac83-ba87f89cc0c7",
  "comment": "Generate a TOTP token from a TOTP key",
  "command": "executeScript",
  "target": "return $browser.generateTOTPToken($secure.totpKey);",
  "targets": [],
  "value": "totpToken"
}

$browser.get(url: string): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	文書のロードが終了したときに解決される promise。
url	string	「 URL 」という完全修飾名で開きます。

$browser.getAllWindowHandles(): Promise<string[]>;

パラメーター	タイプ	説明
RETURN	Promise<string[]>	ウィンドウ・ハンドルの配列を使用して解決される promise。

$browser.getCapabilities(): Promise<Capabilities>;

パラメーター	タイプ	説明
RETURN	Promise<Capabilities>	このインスタンスの機能によって解決される promise。

$browser.getCurrentUrl(): Promise<string>;

パラメーター	タイプ	説明
RETURN	Promise<string>	この問題は、現在の URL で解決される予定です。

$browser.getHeaders(): Map<string, any>;

パラメーター	タイプ	説明
RETURN	Map<string, any>	ユーザー定義ヘッダー

await $browser.addHeader('header1-xxx', 'abcd');
await $browser.addHeaders({
    key1: 'val1',
    key2: 'val2',
});
await $browser.deleteHeaders(['key1']);

await $browser.get(`http://localhost:${devport}/header-test`);
let userHeaders: Map<string, any>  = $browser.getHeaders();
console.log("User customized headers: ", [...userHeaders]);
expect(userHeaders.size).toEqual(2);

$browser.getPageSource(): Promise<string>;

パラメーター	タイプ	説明
RETURN	Promise<string>	現在のページ・ソースで解決される promise。

$browser.getProxy(): FFProxyConfig | CProxyConfig;

この API は、オブジェクト $network を介して呼び出すこともできます：

$network.getProxy(): FFProxyConfig | CProxyConfig;

パラメーター	タイプ	説明
RETURN	CProxyConfig または FFProxyConfig	プロキシー構成オブジェクト (Chrome または Firefox 固有のカプセル化)。

/**
 * Firefox extension - An object encapsulating a complete proxy configuration
 * https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/proxy/settings
 */
export interface FFProxyConfig {
  proxyType?: FFProxyType,
  http?: string;
  ssl?: string,
  ftp?: string;
  autoConfigUrl?: string,
  autoLogin?: boolean,
  httpProxyAll?: boolean,
  passthrough?: string,
  proxyDNS?: boolean,
  socks?: string,
  socksVersion?: number,
}

/**
 * Chrome extension - An object encapsulating a complete proxy configuration
 * https://developer.chrome.com/docs/extensions/reference/proxy/#type-ProxyConfig
 */
export interface CProxyConfig {
  mode: CProxyType,
  rules?: {
    bypassList?: string[],
    fallbackProxy?: ProxyServer,
    proxyForFtp?: ProxyServer,
    proxyForHttp?: ProxyServer,
    proxyForHttps?: ProxyServer,
    singleProxy?: ProxyServer,
  },
  pacScript?: {
    data?: string,
    mandatory?: boolean,
    url?: string,
  },
};

$browser.getSession(): Promise<Session>;

パラメーター	タイプ	説明
RETURN	Promise<Session>	このクライアントのセッションの約束。

$browser.getTitle(): Promise<string>;

パラメーター	タイプ	説明
RETURN	Promise<string>	現在のページのタイトルを使用して解決される promise。

$browser.getWindowHandle(): Promise<string>;

パラメーター	タイプ	説明
RETURN	Promise<string>	現行ウィンドウ・ハンドルを使用して解決される promise。

$browser.manage(): Options;

パラメーター	タイプ	説明
RETURN	Options	このインスタンスのオプション・インターフェース。

これらのオプションは、ブラウザーおよびドライバーの状態を管理するためのメソッドを提供します。

タイプ	説明
addCookie(spec: IWebDriverOptionsCookie): Promise<void>	cookieを追加するコマンドをスケジュールします。
deleteAllCookies(): Promise<void>;	現在のページに表示されているすべての Cookie を削除するコマンドをスケジュールします。
deleteCookie(name: string): Promise<void>;	指定された名前の Cookie を削除するコマンドをスケジュールします。 指定された名前の Cookie が現行ページに表示されない場合、このコマンドはノーオペレーションです。
getCookies(): Promise<IWebDriverCookie[]>;	現行ページに表示されるすべての Cookie を取得するコマンドをスケジュールします。 各Cookieは、 WebDriver ワイヤプロトコルで規定されているとおり、 JSON オブジェクトとして返されます。
getCookie(name: string): Promise<IWebDriverCookie>;	指定された名前の cookie を取得するコマンドをスケジュールします。 そのような Cookie が使用できない場合は、NULL を返します。 このクッキーは、 WebDriver ワイヤプロトコルで規定されているとおり、 JSON オブジェクトとして返されます。
logs(): Logs;	ドライバー・ログを管理するためのインターフェースを提供します。
getTimeouts(): Promise<ITimeouts>;	現在の timeoutsを取得します。
setTimeouts(timeouts: ITimeouts): Promise<void>;	現在の timeoutsを設定します。
window(): Window;	現在の ウィンドウを管理するためのインターフェースを提供します。

パラメーター	タイプ	説明
name	string	Cookie の名前です。
value	string	Cookie の値。
path	string	Cookie パス。 Cookie が追加されると、デフォルトで「/」に設定されます。
domain	string	Cookie が表示されるドメイン。 クッキーが追加されると、デフォルトでは現在のブラウジングコンテキストのドキュメントの URL が設定されます。
secure	boolean	このパラメーターは、Cookie がセキュア Cookie であるかどうかを示します。 デフォルト値は falseです。これは、Cookie がセキュア Cookie ではないことを意味します。
httpOnly	boolean	このパラメータは、そのクッキーが HTTP 専用のクッキーであるかどうかを示します。 デフォルト値は です false。これは、このクッキーが HTTP 専用ではないことを意味します。
expiry	number	ブラウザーから Cookie を取得する場合、有効期限は常にエポック以降の秒数で返されます。

パラメーター	タイプ	説明
script	number	評価済みスクリプトの実行を待機する最大時間を指定します。
pageLoad	number	ページのロードが終了するまで待機する最大時間を指定します。 デフォルトは 300000 ミリ秒です。
implicit	number	ページ上のエレメントを見つけるときに、エレメント・ロケーターが成功するのを待機する最大時間を指定します。 デフォルトは 0 ミリ秒です。

export interface ILocation {
  x: number;
  y: number;
}

export interface ISize {
  width: number;
  height: number;
}

export interface IRectangle {
  x: number;
  y: number;
  width: number;
  height: number;
}

現行ウィンドウを管理するためのインターフェース。

タイプ	説明
getPosition(): Promise<ILocation>;	画面の左上を基準にして、ウィンドウの現在位置を検索します。
setPosition(x: number, y: number): Promise<void>;	現行ウィンドウを位置変更します。
getSize(): Promise<ISize>;	ウィンドウの現行サイズを検索します。
setSize(width: number, height: number): Promise<void>;	現行ウィンドウのサイズを変更します。
getRect(): Promise<IRectangle>;	現在の最上位ウィンドウのサイズと位置を戻します。
setRect({x, y, width, height}: Partial<IRectangle>): Promise<IRectangle>;	現在の最上位ウィンドウのサイズと位置を設定します。 x と y を省略してサイズのみを更新することも、 width と height のオプションを省略して位置のみを更新することもできます。
maximize(): Promise<void>;	現行ウィンドウを最大化します。

let tm = await $browser.manage().getTimeouts();
console.log('current timeout', tm.implicit, tm.pageLoad, tm.script);

await $browser.manage().timeouts().pageLoadTimeout(119);
tm = await $browser.manage().getTimeouts();
expect(tm.pageLoad).toBe(119);
console.log('current timeout', tm.implicit, tm.pageLoad, tm.script);

await $browser.manage().timeouts().pageLoadTimeout(89);
tm = await $browser.manage().getTimeouts();
expect(tm.pageLoad).toBe(89);
console.log('current timeout', tm.implicit, tm.pageLoad, tm.script);

$browser.navigate(): Navigation;

パラメーター	タイプ	説明
RETURN	Navigation	このインスタンスのナビゲーション・インターフェース。

ブラウザー履歴で前後に移動するためのナビゲーション・インターフェース。

タイプ	説明
to(url: string): Promise<void>;	新しい URL に移動するコマンドをスケジュールします。
back(): Promise<void>;	ブラウザー履歴で後方に移動するコマンドをスケジュールします。
forward(): Promise<void>;	ブラウザー履歴で前方に移動するコマンドをスケジュールします。
refresh(): Promise<void>;	現行ページを最新表示するコマンドをスケジュールします。

$browser.setAuthentication(authName: string, authPass: string): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	設定が適用されると、promise が解決されます。
authName	string	認証用のユーザー名。
authPass	string	認証用のユーザー・パスワード。

await $browser.setAuthentication(basicauthuser, password);
await $browser.get(`http://${httpserver}/basic/page1.html`)
.then(() => $browser.takeScreenshot());

$browser.setProxy(proxyURL: string | URL, noProxy?: string): Promise<void>;

この API は、オブジェクト $network を介して呼び出すこともできます。

$network.setProxy(proxyURL: string | URL, noProxy?: string): Promise<void>

パラメーター	タイプ	説明
RETURN	Promise<void>	設定が適用されると、promise が解決されます。
proxyURL	string, URL	プロキシサーバーに接続するための URL 文字列。 URL 文字列は、ノードの url.parse ( urlString ) メソッドで定義されている形式でなければなりません。 例えば、 http://proxy_host:8888 または https://user:pass@proxy_host:8888 です。
noProxy	string	オプション: すべてのプロキシーをバイパスするホストの、コンマ区切りのリスト。

$browser.setProxyAdvanced(proxyConfig: CProxyConfig | FFProxyConfig, authName?: string, authPass?: string): Promise<void>;

この API は、オブジェクト $network を介して呼び出すこともできます。

$network.setProxyAdvanced(proxyConfig: CProxyConfig | FFProxyConfig, authName?: string, authPass?: string): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	設定が適用されると、promise が解決されます。
proxyConfig	CProxyConfig または FFProxyConfig	Chrome または Firefox に固有のカプセル化でのプロキシー構成オブジェクト。
authName	string	オプション: 認証用のプロキシー・サーバーのユーザー名。
authPass	string	オプション: 認証用のプロキシー・サーバーのユーザー・パスワード。

async function testProxyAdvanced() {
  await $browser.clearProxy();
  var ffconfig = {
    proxyType: "manual",
    //proxyType: "autoConfig",
    http: proxy_4,
    ssl: proxy_4,
    ftp: proxy_4,
    autoConfigUrl: pacfile,
    passthrough: noproxy,
    autoLogin: true,
  }

  var pxyserver = {
    host: httpserver,
    port: 8088,
    scheme: "http",
  }

  var cconfig = {
    mode: "fixed_servers",
    rules: {
      bypassList: noproxy.split(','),
      fallbackProxy: {
        host: "my-proxy-server.us.ibm.com",
        port: 8080,
      },
      proxyForFtp: pxyserver,
      proxyForHttp: pxyserver,
      proxyForHttps: pxyserver,
    },
    pacScript: {
      url: pacfile,
    },
  }

  var bname = null;
  await $browser.getCapabilities().then(cap=> {
    bname = cap.getBrowserName();
   });

  var config = (bname == 'chrome') ? cconfig : ffconfig;

  await $browser.setProxyAdvanced(config, proxyuser, password);
  await $browser.get(`http://${httpserver}/demo/page2.html`)
    .then(() => $browser.takeScreenshot());
}

$browser.setProxyAuthentication(authName: string, authPass: string): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	設定が適用されると、promise が解決されます。
authName	string	認証用のプロキシー・サーバーのユーザー名。
authPass	string	認証用のプロキシー・サーバーのユーザー・パスワード。

async function testProxyAuthentication() {
  await $browser.clearProxy();
  await $browser.setProxy(proxy_3, noproxy);
  await $browser.setProxyAuthentication(proxyuser, password);
  await $browser.get(`http://${httpserver}/demo/page2.html`)
    .then(() => $browser.takeScreenshot());
}

$browser.setProxyForHttp(proxyURL: string | URL, noProxy?: string): Promise<void>

この API は、オブジェクト $network を介して呼び出すこともできます。

$network.setProxyForHttp(proxyURL: string | URL, noProxy?: string): Promise<void>

パラメーター	タイプ	説明
RETURN	Promise<void>	設定が適用されると、promise が解決されます。
proxyURL	string, URL	プロキシサーバーに接続するための URL 文字列。 URL 文字列は、Node.js の url.parse メソッド（ urlString ） で定義されている形式でなければなりません。 例えば、 http://proxy_host:8888 または https://user:pass@proxy_host:8888 です。
noProxy	string	オプション: すべてのプロキシーをバイパスする必要があるホストのコンマ区切りリスト。

let website;
let proxyServer = "proxyHost:proxyPort";

console.log(">>>>>>>>>>>>>>>>>>>", "Clear proxy configuration");
await $network.clearProxy();
console.log(">>>>>>>>>>>>>>>>>>>", "Set proxy configuration for HTTP request");
await $network.setProxyForHttp(proxyServer);
website = await accessWebSite();
checkHostname("www.google.com.hk", website)

$browser.setProxyForHttps(proxyURL: string | URL, noProxy?: string): Promise<void>;

この API は、オブジェクト $network を介して呼び出すこともできます。

$network.setProxyForHttps(proxyURL: string | URL, noProxy?: string): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	設定が適用されると promise が解決されます
proxyURL	string, URL	プロキシサーバーに接続するための URL 文字列。 URL 文字列は、ノードの url.parse ( urlString ) メソッドで定義されている形式でなければなりません。 例えば、 http://proxy_host:8888 または https://user:pass@proxy_host:8888 です。
noProxy	string	オプション: すべてのプロキシーをバイパスする必要があるホストのコンマ区切りリスト。

let website;
let sslProxyServer = "username:password@proxyHost:proxyPort";

console.log(">>>>>>>>>>>>>>>>>>>", "Clear proxy configuration");
await $network.clearProxy();
console.log(">>>>>>>>>>>>>>>>>>>", "Set proxy configuration for HTTPS request");
let testURL = new URL("http://" + sslProxyServer);
await $network.setProxyForHttps(testURL);
website = await accessWebSite();
checkHostname("www.google.com", website);

$browser.setProxyPAC(pacScriptURL: string, noProxy?: string, authMap?: Map<string, any>): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	設定が適用されると、promise が解決されます。
pacScriptURL	string	PACスクリプトの URL。
noProxy	string	オプション: すべてのプロキシーをバイパスする必要があるホストのコンマ区切りリスト。
authMap	Map	オプション: プロキシー・サーバーに提供される認証資格情報のマップ。プロキシー・サーバーの Hostname によって鍵が設定されます。 このマップの値は、 {username: "authUsername", password: "authPassword"}の形式で定義する必要があります。

const httpserver = '<DemoServerIP>';
const noproxy = "localhost,google.com,192.168.1.0/24";
const pacfile = `http://${httpserver}/pacfile`;
const authmap = new Map([
  [ httpserver, {username: "proxyuser", password: "passw0rd"} ],
  [ "httpserver2", {username: "user1", password: "passw0rd"} ],
])

async function testProxyPAC() {
  await $browser.clearProxy();
  await $browser.setProxyPAC(pacfile, noproxy, authmap);
  await $browser
    .get(`http://${httpserver}/demo/page2.html`)
    .then(() => $browser.takeScreenshot());
}

$browser.sleep(ms: number): Promise<void>;

パラメーター	タイプ	説明
RETURN	Promise<void>	スリープ終了時に解決される約束。
ms	number	スリープにかかる時間 (ミリ秒)。

await $browser.get("https://www.yahoo.com/");
await $browser.sleep(3 * 1000);
await $browser.takeScreenshot();

$browser.switchTo(): TargetLocator;

パラメーター	タイプ	説明
RETURN	TargetLocator	このインスタンスの TargetLocator インターフェース。

ドライバーのフォーカスを別のフレームまたはウィンドウに変更するためのインターフェース。

タイプ	説明
activeElement(): WebElementPromise;	現在の文書の document.activeElement エレメント、または activeElement が使用できない場合は document.body エレメントを取得するコマンドをスケジュールします。
defaultContent(): Promise<void>;	今後のすべてのコマンドのフォーカスをページの最初のフレームに切り替えるコマンドをスケジュールします。 ターゲットフレームは、以下のいずれかの値として指定できます。 - ` window.frames ` 内のインデックス（0 から始まる）を指定する数値。 - ` WebElement ` への参照。これは、`<frame>` または `<iframe iframe > frame ` DOM 要素に対応します。 - ページ上の最上位のフレームを選択するための `top` null 値。 passing は、 nulldefaultContent を呼び出すのと同じです。
frame(id: Number |WebElement| null): Promise<void>;	今後のすべてのコマンドのフォーカスをページ上の別のフレームに変更します。
parentFrame(): Promise<void>;	今後のすべてのコマンドのフォーカスを、現在選択されているフレームの親フレームに変更します。 ドライバーが既に最上位のブラウズ・コンテキストにフォーカスしている場合、このコマンドは効果がありません。
window(nameOrHandle: string): Promise<void>;	今後のすべてのコマンドのフォーカスを別のウィンドウに切り替えるコマンドをスケジュールします。 Windows は、その window.name 属性またはハンドル（ getWindowHandle によって返されるもの）で指定できます。
newWindow(typeHint: string): Promise<void>;	ブラウザウィンドウを作成し、このドライバの今後のコマンドのフォーカスを新しいウィンドウに切り替えます。 typeHint 「ウィンドウ」または「タブ」。 作成されたウィンドウは、要求されたタイプであることは保証されません。 ドライバが要求されたタイプに対応していない場合、ドライバが対応している任意のタイプの新しいブラウザウィンドウが開かれます。 ドライバーが新しいウィンドウにフォーカスを移すと、返されたプロミスが決済されます。
alert(): AlertPromise;	window.alert()、 window.confirm()、および window.prompt()によって開かれたものなど、アクティブなモーダル・ダイアログにフォーカスを変更するコマンドをスケジュールします。 使用可能なオープン・アラートがない場合、返された promise は error.NoSuchAlertError で拒否されます。

/**
 * samples of getting current window handle
 * switch to a new window
 * open new page in new tab
 */
console.log("Windows handle: ", await $browser.getWindowHandle(), "Current url: ", await $browser.getCurrentUrl());
console.log("switch to calendar tab");
let originalWindow = await $browser.getWindowHandle();
await $browser.switchTo().newWindow();

/**
 * navigate to www.timeanddate.com
 * assert page title by getTitle() api
 * assert page title by getPageSource() api
 */
console.log("Access time and date page");
await $browser.get("http://www.timeanddate.com");
let page = await $browser.getPageSource();
assert.isTrue(page.includes("<title>timeanddate.com</title>"));
console.log("Page title: ", await $browser.getTitle());

/**
 * switch back to original window
 * take screenshot
 */
await $browser.switchTo().window(originalWindow);
await $browser.takeScreenshot();

$browser.takeScreenshot(): Promise<string>;

パラメーター	タイプ	説明
RETURN	Promise<string>	base-64 でエンコードされた PNG としてスクリーン・ショットを使用して解決される promise。

$browser.wait(
    condition: WebElementCondition,
    opt_timeout?: number,
    opt_message?: string): WebElementPromise;

パラメーター	タイプ	説明
RETURN	Promise<string>	条件関数によって返される、または条件がタイムアウトになった場合に拒否される最初の真の値で解決される promise。 入力条件が WebElementCondition, のインスタンスである場合、戻り値は WebElementPromise となります。
condition	IThenable<(T|null)> または Condition<(T|null)> または function(WebDriver): (T|null)	待機する条件。promise として定義されるか、条件オブジェクトとして定義されるか、条件として評価する関数として定義されます。
opt_timeout	number	条件が true になるのを待機する期間 (ミリ秒)。
opt_message	stringまたはfunction	待機がタイムアウトになった場合に使用するオプションのメッセージ。

例 1: エレメントがページに表示されるのを最大 10 秒待機するには、以下の例に示すようにコマンドを使用します。

async function example() {
  let button = await $browser.wait(
    $driver.until.elementLocated($driver.By.id("foo")),
    10000
  );
  await button.click();
}

例 2: エレメントを待機してクリックするには、以下の例に示すようにコマンドを使用します。

await $browser.wait(until.elementLocated(by), timeout);
const element = await $browser.findElement(by, timeout);
await $browser.wait(until.elementIsVisible(element), timeout, `${by} not visible`);
await $browser.wait(until.elementIsEnabled(element), timeout, `${by} not enabled`);
await element.click();

$browser.waitForAndFindElement(locator: Locator, timeout?: number) : WebElementPromise;

この関数は以下のようになります。

const element = await $browser.wait(until.elementLocated(locator), timeout);
await $browser.wait(until.elementIsVisible(element), timeout);
return await $browser.findElement(locator);

パラメーター	タイプ	説明
RETURN	WebElementPromise	見つかったエレメントに対してコマンドを発行するために使用できる WebElement 。 エレメントが見つからない場合、エレメントは無効になり、スケジュールされているすべてのコマンドが停止します。
locator	by.By | function	使用するロケーター。
timeout	number	オプション: 待機する時間の長さ (ミリ秒)。

$browser.waitForAndFindElement($driver.By.id("username"), 10000);

$browser.waitForPendingRequests(timeout?: number): Promise<void>;

この関数は、以下のようになります。

let script = "return document.readyState === 'complete'";
await $browser.wait(() => {
    return $browser.executeScript(script);
}, timeout);

パラメーター	タイプ	説明
RETURN	Promise<void>	文書とすべての副次リソースのロードが終了したときに解決される promise。
timeout	number	待機する時間の長さ (ミリ秒)。