Run your TypeScript test on BrowserStack

Learn how to run your Cypress tests with TypeScript across 100+ browser-OS combinations.

Introduction

TypeScript is a widely adopted programming language that enables developers to build large-scale applications with improved code maintainability and robustness.

Prerequisites

• BrowserStack Username and Access key, which you can find in your account settings. If you have not created an account yet, you can sign up for a Free Trial or purchase a plan.
• NodeJS version 14 or higher is installed.

Run a sample build

To run TypeScript test with BrowserStack, perform the following steps:

Clone sample git repository

Clone the typescript-cypress-browserstack sample repo on GitHub using the following command:

git clone https://github.com/browserstack/typescript-cypress-browserstack.git
cd typescript-cypress-browserstack

Install the dependencies

Install dependencies using the following command:

npm install

Set BrowserStack credentials

Set your BrowserStack credentials in the script as follows:

Navigate to the browserstack.json file in the typescript-cypress-browserstack directory and set YOUR_USERNAME and YOUR_ACCESS_KEY.

{
  "auth": {
    "username": "YOUR_USERNAME",
    "access_key": "YOUR_ACCESS_KEY"
  },
}

Alternatively, you can set the environment variables in your system as follows:

# Set these values in your ~/.zprofile (zsh) or ~/.profile (bash)
export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"

# setx.exe does not set the environment variable in the current command prompt, but it will be available in subsequent command prompts
setx BROWSERSTACK_USERNAME="YOUR_USERNAME"
setx BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"

# Verify whether the variables have been set
echo BROWSERSTACK_USERNAME
echo BROWSERSTACK_ACCESS_KEY

Additional Configuration

Set platforms to test on

Set the browsers/devices you want to test in the browserstack.json file.

{
"browsers": [{
    "browser": "chrome",
    "os": "Windows 11",
    "versions": ["latest"]
  },
  {
    "browser": "firefox",
    "os": "Windows 10",
    "versions": ["latest"]
  },
  {
    "browser": "webkit",
    "os": "OS X Ventura",
    "versions": ["latest"]
  }]
}

Specify npm_dependencies

You can use the following keys in the run_settings section under browserstack.json to specify the npm packages and any options that the packages might need for your tests to run successfully.

{
"run_settings": {
  "cypress_config_file": "./cypress.config.ts",
  "npm_dependencies": {
      "typescript": "^5.0.4",
      "cypress": "^12.12.0",
      "@cypress/xpath": "^2.0.3"
  },
  "package_config_options": {},
  "headless": false
    }
  },

Update the Cypress config file

Update the cypress.config.ts file as shown:

const { defineConfig } = require("cypress");

module.exports = defineConfig({
  experimentalWebKitSupport: true,
  e2e: {
    setupNodeEvents(on, config) {
      // implement node event listeners here
    },
  },
});

Run your test

Run your first test using the following command:

npm run sample-test

Test your Local Configuration

BrowserStack can integrate with test suites pointing to your localhost URL, staging environment, and even websites behind one or more proxies/firewalls. This is done using BrowserStack Local - a tunneling feature that establishes a secure connection between your machine and the BrowserStack Cloud.

Configure BrowserStack Local

Ensure the browserstackLocal property is set to true in your browserstack.json file. You can now test your private websites on BrowserStack.

...
{
  "connection_settings": {
    "local": true,
  }
}
...

Run local test

From the root directory of this project, run the following command:

npm run sample-local-test

View your test results

After you run your test, visit the Automate dashboard to view your test results as follows:

All the tests run as part of each spec file are grouped by the browser combination. When you click any browser combination, you can see the detailed view that includes video logs, text logs, etc. If any tests run into an error, relevant screenshots are captured in the Screenshots tab.

On your command-line tool, you can see the completed tests along with their current status as the build execution progresses. After the tests are executed, you can access the results in the results folder that contains the HTML & JSON files with the build summary.