timeouts.md

Timeouts

By default, asynchronous hooks and steps timeout after 5000 milliseconds. This can be modified globally with:

var {setDefaultTimeout} = require('@cucumber/cucumber');

setDefaultTimeout(60 * 1000);

A specific hook's or step's timeout can be set with:

var {Before, Given} = require('@cucumber/cucumber');

Before({timeout: 60 * 1000}, function() {
  // Does some slow browser/filesystem/network actions
});

Given(/^a slow step$/, {timeout: 60 * 1000}, function() {
  // Does some slow browser/filesystem/network actions
});

Note that you should not call setDefaultTimeout from within other support code e.g. a step, hook or your World class; it should be called globally.

Disable Timeouts

DO NOT USE THIS UNLESS ABSOLUTELY NECESSARY

Disable timeouts by setting it to -1. If you use this, you need to implement your own timeout protection. Otherwise the test suite may end prematurely or hang indefinitely. The helper wrapPromiseWithTimeout, which cucumber-js itself uses to enforce timeouts is available if needed.

var {Before, Given, wrapPromiseWithTimeout} = require('@cucumber/cucumber');

Given('the operation completes within {n} minutes', {timeout: -1}, function(minutes) {
  const milliseconds = (minutes + 1) * 60 * 1000
  return wrapPromiseWithTimeout(this.verifyOperationComplete(), milliseconds);
});