README.md

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
• Guides
  • Basic Guides
    • Install TestCafe
    • Organize Tests
    • Select Page Elements
    • Interact with the Page
    • Assert
    • Obtain Client-Side Info
    • Run Tests
    • Debug
  • Advanced Guides
    • Authentication
    • Screenshots and Videos
    • Intercept HTTP Requests
    • Inject Client Scripts
    • Test HTTPS Features and HTTP/2 Websites
    • Detect the Client Browser and Platform
    • Use TestCafe Docker Image
  • Concepts
    • Browsers
    • Reporters
    • Page Model
    • TypeScript and CoffeeScript
    • Built-in Wait Mechanisms
  • Continuous Integration
    • AppVeyor
    • Azure DevOps
    • Bitbucket Pipelines
    • CircleCI
    • GitHub Actions
    • GitLab
    • Jenkins
    • TeamCity
    • Travis
    • Travis + Sauce Labs
  • Extend TestCafe
    • Install Plugins
    • Reporter Plugin
    • Browser Provider Plugin
• REFERENCE
  • Command Line Interface
  • Configuration File
  • Test API
    • Global Functions
      • fixture
      • test
    • ClientFunction
      • Constructor
      • with
    • DOMNodeState
    • Fixture
      • after
      • afterEach
      • before
      • beforeEach
      • clientScripts
      • disablePageCaching
      • httpAuth
      • meta
      • only
      • page
      • requestHooks
      • skip
    • RequestHook
      • Constructor
      • onRequest
      • onResponse
    • RequestLogger
      • Constructor
      • clear
      • contains
      • count
      • requests
    • RequestMock
      • Constructor
      • onRequestTo
      • respond
    • Role
      • Constructor
      • anonymous
    • Selector
      • Constructor
      • addCustomDOMProperties
      • addCustomMethods
      • child
      • count
      • exists
      • filter
      • filterHidden
      • filterVisible
      • find
      • nextSibling
      • nth
      • parent
      • prevSibling
      • sibling
      • with
      • withAttribute
      • withExactText
      • withText
    • Test
      • after
      • before
      • clientScripts
      • disablePageCaching
      • httpAuth
      • meta
      • only
      • page
      • requestHooks
      • skip
    • TestController
      • addRequestHooks
      • browser
      • clearUpload
      • click
      • ctx
      • debug
      • doubleClick
      • drag
      • dragToElement
      • eval
      • expect
      • expect.contains
      • expect.eql
      • expect.gt
      • expect.gte
      • expect.lt
      • expect.lte
      • expect.match
      • expect.notContains
      • expect.notEql
      • expect.notMatch
      • expect.notOk
      • expect.notTypeOf
      • expect.notWithin
      • expect.ok
      • expect.typeOf
      • expect.within
      • fixtureCtx
      • getBrowserConsoleMessages
      • getNativeDialogHistory
      • hover
      • maximizeWindow
      • navigateTo
      • pressKey
      • removeRequestHooks
      • resizeWindow
      • resizeWindowToFitDevice
      • rightClick
      • selectEditableContent
      • selectText
      • selectTextAreaContent
      • setFilesToUpload
      • setNativeDialogHandler
      • setPageLoadTimeout
      • setTestSpeed
      • switchToIframe
      • switchToMainWindow
      • takeElementScreenshot
      • takeScreenshot
      • typeText
      • useRole
      • wait
  • TestCafe API
    • Global Functions
      • createTestCafe
    • BrowserConnection
      • ready
      • url
    • LiveModeRunner
    • Runner
      • browsers
      • clientScripts
      • concurrency
      • filter
      • reporter
      • run
      • screenshots
      • src
      • startApp
      • stop
      • tsConfigPath
      • useProxy
      • video
    • TestCafe
      • close
      • createBrowserConnection
      • createLiveModeRunner
      • createRunner
  • Plugin API
    • BrowserProvider Interface
    • Reporter Interface
• Recipes
  • Basics
    • Test <select> Elements
    • Test Static HTML Pages
    • Test on Remote Computers and Mobile Devices
  • Best Practices
    • Create Helpers
    • Create Data-Driven Tests
  • Integrations
    • Import Third-Party Modules
    • Testing Library API
    • Angular CLI Builder
    • Gulp
    • Grunt
    • Test Websites That Use reCAPTCHA
    • Flow Type Checker
  • Configuration
    • Access Environment Variables in Tests
  • Debugging
    • Chrome Developer Tools
    • Visual Studio Code
    • WebStorm