browser.md

selenidejs › Browser

Class: Browser

Hierarchy

• Entity

  ↳ Browser

Implements

• Assertable
• Matchable
• Assertable
• Matchable

Index

Constructors

• constructor

Properties

• configuration
• wait

Accessors

• alert
• driver

Methods

• all
• back
• clearCookies
• clearLocalStorage
• clearSessionStorage
• closeCurrentTab
• element
• executeScript
• forward
• get
• goToNextTab
• goToPreviousTab
• goToTab
• matching
• open
• perform
• quit
• refresh
• resizeWindow
• screenshot
• should
• switchToDefaultFrame
• toString
• waitUntil
• with
• chrome
• chromeWith
• configuredWith

Constructors

constructor

+ new Browser(configuration: Partial‹Configuration›): Browser

Overrides Entity.constructor

Defined in lib/browser.ts:41

Parameters:

Name	Type	Default
configuration	Partial‹Configuration›	{}

Returns: Browser

Properties

configuration

• configuration: Configuration

Inherited from Entity.configuration

Defined in lib/entity.ts:52

---

Protected wait

• wait: Wait‹this›

Inherited from Entity.wait

Defined in lib/entity.ts:53

Accessors

alert

• get alert(): AlertPromise‹›

Defined in lib/browser.ts:227

Returns: AlertPromise‹›

---

driver

• get driver(): WebDriver

Defined in lib/browser.ts:51

Returns: WebDriver

Methods

all

▸ all(located: string | By | object, customized?: Partial‹Configuration›): Collection

Defined in lib/browser.ts:78

Parameters:

Name	Type
located	string | By | object
customized?	Partial‹Configuration›

Returns: Collection

---

back

▸ back(): Promise‹void›

Defined in lib/browser.ts:145

Returns: Promise‹void›

---

clearCookies

▸ clearCookies(): Promise‹Browser›

Defined in lib/browser.ts:215

Returns: Promise‹Browser›

---

clearLocalStorage

▸ clearLocalStorage(): Promise‹Browser›

Defined in lib/browser.ts:203

Returns: Promise‹Browser›

---

clearSessionStorage

▸ clearSessionStorage(): Promise‹Browser›

Defined in lib/browser.ts:209

Returns: Promise‹Browser›

---

closeCurrentTab

▸ closeCurrentTab(): Promise‹Browser›

Defined in lib/browser.ts:132

Returns: Promise‹Browser›

---

element

▸ element(located: string | By‹› | object, customized?: Partial‹Configuration›): Element

Defined in lib/browser.ts:61

Parameters:

Name	Type
located	string | By‹› | object
customized?	Partial‹Configuration›

Returns: Element

---

executeScript

▸ executeScript(script: string | function, ...args: any[]): Promise‹unknown›

Defined in lib/browser.ts:97

Parameters:

Name	Type
script	string | function
...args	any[]

Returns: Promise‹unknown›

---

forward

▸ forward(): Promise‹void›

Defined in lib/browser.ts:149

Returns: Promise‹void›

---

get

▸ get<R>(query: Lambda‹this, R›): Promise‹R›

Inherited from Entity.get

Defined in lib/entity.ts:103

Type parameters:

▪ R

Parameters:

Name	Type
query	Lambda‹this, R›

Returns: Promise‹R›

---

goToNextTab

▸ goToNextTab(): Promise‹Browser›

Defined in lib/browser.ts:153

Returns: Promise‹Browser›

---

goToPreviousTab

▸ goToPreviousTab(): Promise‹Browser›

Defined in lib/browser.ts:160

Returns: Promise‹Browser›

---

goToTab

▸ goToTab(indexOrId: number | string): Promise‹Browser›

Defined in lib/browser.ts:167

Parameters:

Name	Type
indexOrId	number | string

Returns: Promise‹Browser›

---

matching

▸ matching(...conditions: Condition‹this›[]): Promise‹boolean›

Inherited from Entity.matching

Defined in lib/entity.ts:88

Parameters:

Name	Type
...conditions	Condition‹this›[]

Returns: Promise‹boolean›

---

open

▸ open(relativeOrAbsoluteUrl: string): Promise‹Browser›

Defined in lib/browser.ts:105

Parameters:

Name	Type
relativeOrAbsoluteUrl	string

Returns: Promise‹Browser›

---

perform

▸ perform(command: Lambda‹this, void›): Promise‹this›

Inherited from Entity.perform

Defined in lib/entity.ts:94

Parameters:

Name	Type
command	Lambda‹this, void›

Returns: Promise‹this›

---

quit

▸ quit(): Promise‹void›

Defined in lib/browser.ts:137

Returns: Promise‹void›

---

refresh

▸ refresh(): Promise‹void›

Defined in lib/browser.ts:141

Returns: Promise‹void›

---

resizeWindow

▸ resizeWindow(width: number, height: number): Promise‹Browser›

Defined in lib/browser.ts:121

Parameters:

Name	Type
width	number
height	number

Returns: Promise‹Browser›

---

screenshot

▸ screenshot(): Promise‹Buffer›

Defined in lib/browser.ts:126

Returns: Promise‹Buffer›

---

should

▸ should(...conditions: Condition‹this›[]): Promise‹this›

Inherited from Entity.should

Defined in lib/entity.ts:77

Parameters:

Name	Type
...conditions	Condition‹this›[]

Returns: Promise‹this›

---

switchToDefaultFrame

▸ switchToDefaultFrame(): Promise‹Browser›

Defined in lib/browser.ts:187

Returns: Promise‹Browser›

---

toString

▸ toString(): string

Defined in lib/browser.ts:55

Returns: string

---

waitUntil

▸ waitUntil(...conditions: Condition‹this›[]): Promise‹boolean›

Implementation of Matchable

Inherited from Entity.waitUntil

Defined in lib/entity.ts:84

Parameters:

Name	Type
...conditions	Condition‹this›[]

Returns: Promise‹boolean›

---

with

▸ with(customConfig: Partial‹Configuration›): Browser

Defined in lib/browser.ts:47

Parameters:

Name	Type
customConfig	Partial‹Configuration›

Returns: Browser

---

Static chrome

▸ chrome(): Browser

Defined in lib/browser.ts:39

Returns: Browser

---

Static chromeWith

▸ chromeWith(): Customized‹Browser›

Defined in lib/browser.ts:34

Returns: Customized‹Browser›

---

Static configuredWith

▸ configuredWith(): Customized‹Browser›

Defined in lib/browser.ts:30

Returns: Customized‹Browser›