@zuke/cypress

`@zuke/cypress` — typed `CypressTasks` wrappers for the

Symbols

# CypressInfoSettings class

class CypressInfoSettings extends CypressSettings

Settings for cypress info.

# CypressInstallSettings class

class CypressInstallSettings extends CypressSettings

Settings for cypress install (the bundled binary).

Member	Signature	Doc
`force`	`force(): this`	Reinstall even if already present (`--force`).

# CypressOpenSettings class

class CypressOpenSettings extends CypressTestingSettings

Settings for cypress open (interactive).

# CypressRunSettings class

class CypressRunSettings extends CypressTestingSettings

Settings for cypress run (headless).

Member	Signature	Doc
`headed`	`headed(): this`	Run in a headed browser (`--headed`).
`spec`	`spec(pattern: string): this`	Glob of spec files to run (`--spec`).
`record`	`record(): this`	Record the run to Cypress Cloud (`--record`).
`parallel`	`parallel(): this`	Run in parallel across machines (`--parallel`).
`tag`	`tag(value: string): this`	Tag the recorded run (`--tag`).
`port`	`port(value: number): this`	Override the server port (`--port`).

# CypressSettings class

class CypressSettings extends ToolSettings

Base for all cypress subcommand settings: the binary is cypress.

# CypressTasks const

const CypressTasks: CypressTasksApi

Typed task functions for the cypress CLI.

# CypressTasksApi interface

interface CypressTasksApi

The shape of CypressTasks.

Member	Signature	Doc
`run`	`run(configure?: Configure<CypressRunSettings>): Promise<CommandOutput>`	Run tests in headless mode: `cypress run`.
`open`	`open(configure?: Configure<CypressOpenSettings>): Promise<CommandOutput>`	Open the interactive runner: `cypress open`.
`install`	`install(configure?: Configure<CypressInstallSettings>): Promise<CommandOutput>`	Install the bundled binary: `cypress install`.
`verify`	`verify(configure?: Configure<CypressVerifySettings>): Promise<CommandOutput>`	Verify the installation: `cypress verify`.
`info`	`info(configure?: Configure<CypressInfoSettings>): Promise<CommandOutput>`	Print environment info: `cypress info`.

# CypressTestingSettings class

class CypressTestingSettings extends CypressSettings

Base for the run/open commands, which share testing-type selection, a browser, a config file, and a project path.

Member	Signature	Doc
`e2e`	`e2e(): this`	Run end-to-end tests (`--e2e`).
`component`	`component(): this`	Run component tests (`--component`).
`browser`	`browser(name: string): this`	Choose the browser, e.g. `chrome` or `electron` (`--browser`).
`configFile`	`configFile(path: PathLike): this`	Use an explicit config file (`--config-file`).
`project`	`project(path: PathLike): this`	Run against a project at the given path (`--project`).

# CypressVerifySettings class

class CypressVerifySettings extends CypressSettings

Settings for cypress verify.