Documentation

This is the documentation's development version. The functionality described here may not be included in the current release version. Unreleased functionality may change or be dropped before the next release. The release version's documentation is available at the TestCafe website.

• GETTING STARTED
• USING TESTCAFE
  • Installing TestCafe
  • Command Line Interface
  • Programming Interface
    • TestCafe Class
    • BrowserConnection Class
    • Runner Class
    • LiveModeRunner Class
    • createTestCafe Factory
  • Configuration File
  • Using TestCafe Docker Image
  • Common Concepts
    • Browsers
      • Browser Support
      • Testing in Headless Mode
      • Using Chrome Device Emulation
      • User Profiles
    • Concurrent Test Execution
    • Live Mode
    • Screenshots and Videos
    • Inject Scripts into Tested Pages
    • Reporters
    • Test HTTPS and HTTP/2 Websites
• TEST API
  • Test Code Structure
    • Fixtures
    • Tests
      • Test Controller
      • Setting Test Speed
    • Specifying the Start Webpage
    • Specifying Testing Metadata
      • Using Metadata in Reports
    • Initialization and Clean-Up
      • Test Hooks
      • Fixture Hooks
    • Skipping Tests
  • Selecting Page Elements
    • Selectors
      • Creating Selectors
      • Using Selectors
      • Functional-Style Selectors
      • Selector Options
      • Extending Selectors
      • Edge Cases and Limitations
    • DOM Node State
    • Framework-Specific Selectors
    • Examples of Working with DOM Elements
  • Actions
    • Click
    • Double Click
    • Right Click
    • Drag Element
    • Hover
    • Select Text
    • Type Text
    • Press Key
    • Navigate
    • Take Screenshot
    • Upload
    • Resize Window
    • Action Options
  • Assertions
    • Assertion API
  • Obtaining Data from the Client
    • Examples of Using Client Functions
  • Intercepting HTTP Requests
    • Log HTTP Requests
    • Mock HTTP Requests
    • Create a Custom HTTP Request Hook
    • Select Requests to be Handled by the Hook
    • Attach Hooks to Tests and Fixtures
    • requestOptions Object
  • Built-In Waiting Mechanisms
  • Authentication
    • User Roles
    • HTTP Authentication
  • Pausing the Test
  • Handling Native Dialogs
  • Working with <iframes>
  • Debugging
  • Accessing Console Messages
  • TypeScript Support
  • CoffeeScript Support
  • A-Z Index
• EXTENDING TESTCAFE
  • Reporter Plugin
    • Reporter Methods
    • Helpers
  • Browser Provider Plugin
    • Browser Provider Methods
• CONTINUOUS INTEGRATION
  • AppVeyor
  • Azure DevOps
  • Bitbucket Pipelines
  • CircleCI
  • GitLab
  • Jenkins
  • TeamCity
  • Travis
  • Travis + Sauce Labs
• RECIPES
  • Access Environment Variables in Tests
  • Create Data-Driven Tests
  • Debug Tests
    • Chrome Developer Tools
    • Visual Studio Code
    • WebStorm
  • Extract Reusable Test Code
    • Use Page Model
    • Create Helpers
  • Find Code Issues with Flow Type Checker
  • Import Third-Party Modules
  • Test <select> Elements
  • Test Static HTML Pages
  • Test on Remote Computers and Mobile Devices
  • Use Angular CLI Builder
  • Use Task Runners
    • Grunt
    • Gulp