extract

Reads a value from the page and writes it to the test’s env map. When schema is set, the returned value must validate against it or the step fails.

Parameters

Parameter	Type	Required	Description
`goal`	`string`	Yes	Natural-language description of the value to extract.
`schema`	`object`	No	JSON Schema the extracted value must validate against.
`iframe`	`string`	No	URL or URL pattern of the iframe that contains the target element.
`saveAs`	`string`	No	Name of the variable to write this step’s return value to.
`retries`	`number`	No	Number of times to retry the step on failure before failing the test.
`skipped`	`boolean`	No	Skip this step at execution time.

Shorthand

Pair with saveAs to capture the value into env.

- extract: the order id shown in the confirmation banner

Examples

- extract:
    goal: the main heading text shown on the page
    saveAs: EXTRACTED_HEADING

- extract:
    goal: The discounted subtotal in the order summary
    schema:
      type: object
      properties:
        amount:
          type: number
      required: [amount]
    saveAs: ORDER

- extract:
    goal: the company name shown on the YC profile page
    iframe: https://www.ycombinator.com/companies
    saveAs: COMPANY_NAME

Overview

AI

Mouse

Keyboard

Form

Scroll

Navigation

Waits

Page checks

Element checks

Network

Storage

Authentication

Visual

Connectivity

Scripts

Control flow

Parameters

Shorthand

Examples

​Parameters

​Shorthand

​Examples

​Related

Parameters

Shorthand

Examples

Related