Skip to main content

Waiting for Things

BrowserQL offers 5 different ways to wait for preconditions to be met on the page before returning the response. These are:

BQL Schemas

For more details on BQL mutations, refer to the BrowserQL Schema reference pages.

Rest API

Taking Screenshots can also be done with Browserless Rest API. For endpoint details, parameters, and code samples, see the Browserless REST API.

waitForNavigation​

Waits for a navigation even to fire, useful for clicking an element and waiting for a page load.

The object can have any of these values:

  • timeout: Float, optional — The maximum amount of time, in milliseconds, to wait for the page to load, overriding any defaults. Default timeout is 30 seconds, or 30000.
  • waitUntil: WaitUntilGoto enum, optional — When to consider the page fully-loaded and proceed with further execution
mutation Screenshot {
  goto(url: "https://example.com/") {
    status
  }

  waitForNavigation(waitUntil: load) {
    status
  }
}

waitForRequest​

Waits for the browser to make a particular request.

The object can have any of these values:

  • method: Method, optional — The method of the request to wait for.
  • timeout: Float, optional — How long to wait for the request to be made before timing out, overriding any defaults. Default timeout is 30 seconds, or 30000.
  • url: String, optional — The pattern of the request URL to wait for, using glob-style pattern-matching.
mutation Screenshot {
  goto(url: "https://example.com/") {
    status
  }

  waitForRequest(method: GET) {
    time
  }
}

waitForResponse​

Waits for a particular network response to be made back to the browser.

The object can have any of these values:

  • statuses: [int] list, optional — The HTTP Response code(s) of the URL to wait for. Can be a single HTTP code or a list of desired codes.
  • url: String, optional — The pattern of the response URL to wait for, using glob-style pattern-matching.
mutation Screenshot {
  goto(url: "https://example.com/") {
    status
  }

  waitForResponse(codes: [200]) {
    time
  }
}

waitForSelector​

Wait for a selector to appear in page. If at the moment of calling the method the selector already exists, the method will return immediately. If the selector doesn't appear after the timeout milliseconds of waiting, the function will throw.

The object can have any of these values:

  • selector: String, required — A valid CSS selector.
  • hidden Boolean, optional — Wait for the selected element to not be found in the DOM or to be hidden, i.e. have display: none or visibility: hidden CSS properties.
  • timeout: Number, optional — Maximum number of milliseconds to wait for the selector before failing.
  • visible: Boolean, optional — Wait for the selected element to be present in DOM and to be visible, i.e. to not have display: none or visibility: hidden CSS properties.
mutation Screenshot {
  goto(url: "https://example.com/") {
    status
  }

  waitForSelector(selector: "h1" timeout: 5000) {
    selector
  }
}

waitForTimeout​

Wait for a period of time, defined in milliseconds.

The object needs the following value:

  • time: Float, required - The amount of time to wait for, in milliseconds.
mutation Screenshot {
  goto(url: "https://example.com/") {
    status
  }

  waitForTimeout(time: 1000) {
    time
  }
}