Skip to content

gameface-e2e-config.js

The gameface-e2e-config.js file is a configuration file for the gameface-e2e testing framework. It allows you to specify various properties that control the behavior of the framework when running your tests.

PropertyTypeDescription
gamefacePathStringSpecifies the path to your Player.exe.
testsStringSpecifies the path to your test .spec.js files.
specTimeoutNumberSets the timeout for tests in spec files. The default is 10 seconds. Use this property to increase the timeout if needed.
bailBooleanEnables bailing on the first failure.

Here is an example of a gameface-e2e-config.js file:

gameface-e2e-config.js
module.exports = {
gamefacePath: "C:/Gameface/Player/Player.exe",
tests: "examples/**/*.spec.js",
specTimeout: 20000,
bail: true
}

If you are using TypeScript or a code editor that supports JSDoc, you can get autocompletion for the configuration properties by adding the following JSDoc comment at the top of your gameface-e2e-config.js file:

gameface-e2e-config.js
/** @type {import('gameface-e2e').GamefaceE2EConfig} */
module.exports = {
gamefacePath: "C:/Gameface/Player/Player.exe",
tests: "examples/**/*.spec.js",
specTimeout: 20000,
bail: true
}

Like this, your editor will provide suggestions and type checking for the configuration properties.