url

The url command loads an URL in the browser. If a baseUrl is specified in the config, it will be prepended to the url parameter using node's url.resolve() method. Calling browser.url('...') with the same url as last time will trigger a page reload. However, if the url contains a hash, the browser will not trigger a new navigation and the user has to refresh the page to trigger one.

In a WebDriver BiDi session the command returns the browsing context it navigated. That is the session's initial top-level context: a later browser.url() navigates the same context, and load metadata is context.request. In a Classic session the command still returns void.

context.request contains information about the request and response data of the page load:

interface WebdriverIO.Request {
  id?: string
  url: string
  timestamp: number
  navigation?: string
  redirectChain?: string[],
  headers: Record<string, string>
  cookies?: NetworkCookie[]
  \/**
   * Error message if request failed
   *\/
  error?: string
  response?: {
      fromCache: boolean
      headers: Record<string, string>
      mimeType: string
      status: number
  },
  /**
   * List of all requests that were made due to the main request.
   * Note: the list may be incomplete and does not contain request that were
   * made after the command has finished.
   *
   * The property will be undefined if the request is not a document request
   * that was initiated by the browser.
   *\/
  children?: Request[]
}

The command supports the following options:

note

These features unfortunately won't be available to you if your remote environment doesn't support WebDriver Bidi. You can check if Bidi is support in your session by looking into the browser.isBidi property.

wait

The desired state the requested resource should be in before finishing the command. It supports the following states:

• none: no wait after the page request is made and the response is received
• interactive: wait until the page is interactive
• complete: wait until the DOM tree of the page is fully loaded
• networkIdle: wait until there are no pending network requests

headers

Headers to be sent with the request.

Default: {}

auth

Basic authentication credentials. Note: this will overwrite the existing Authorization header if provided in the headers option.

timeout

If set to a number, the command will wait for the specified amount of milliseconds for the page to load all responses before returning.

Note: for this to have an impact, it requires the wait option to be set to networkIdle.

Default: 5000

Usage

await browser.url(url, { wait, timeout, onBeforeLoad, auth, headers })

Parameters

Name	Type	Details
url optional	string	the URL to navigate to
options optional	UrlOptions	navigation options
options.wait optional	'none', 'interactive', 'networkIdle', 'complete'	The desired state the requested resource should be in before finishing the command. Default: 'complete'
options.timeout optional	number	If set to a number, the command will wait for the specified amount of milliseconds for the page to load all responses before returning. Default: 5000
options.onBeforeLoad optional	Function	A function that is being called before your page has loaded all of its resources. It allows you to easily mock the environment, e.g. overwrite Web APIs that your application uses.
options.auth optional	{user: string, pass: string}	basic authentication credentials
options.headers optional	Record<string, string>	headers to be sent with the request

Examples

url.js

// navigate to a new URL
const context = await browser.url('https://webdriver.io');
console.log(context.url); // outputs: "https://webdriver.io"
console.log(context.request?.response?.status); // outputs: 200
console.log(context.request?.response?.headers); // outputs: { 'content-type': 'text/html; charset=UTF-8' }

baseUrlResolutions.js

// With a base URL of http://example.com/site, the following url parameters resolve as such:
// When providing a scheme:
// https://webdriver.io
await browser.url('https://webdriver.io');

// When not starting with a slash, the URL resolves relative to the baseUrl
// http://example.com/site/relative
await browser.url('relative');

// When starting with a slash, the URL resolves relative to the root path of the baseUrl
// http://example.com/rootRelative
await browser.url('/rootRelative');

basicAuth.js

// navigate to a URL with basic authentication
await browser.url('https://the-internet.herokuapp.com/basic_auth', {
    auth: {
        user
        pass
    }
});
await expect($('p=Congratulations! You must have the proper credentials.').toBeDisplayed();

onBeforeLoad.js

// navigate to a URL and mock the battery API
await browser.url('https://pazguille.github.io/demo-battery-api/', {
    onBeforeLoad (win) {
        // mock "navigator.battery" property
        // returning mock charge object
        win.navigator.getBattery = () => Promise.resolve({
            level: 0.5,
            charging: false,
            chargingTime: Infinity,
            dischargingTime: 3600, // seconds
        })
    }
})
// now we can assert actual text - we are charged at 50%
await expect($('.battery-percentage')).toHaveText('50%')
// and has enough juice for 1 hour
await expect($('.battery-remaining')).toHaveText('01:00)

Returns

• <WebdriverIO.BrowsingContext> returns: the browsing context that was navigated. In a WebDriver Classic