Why there's no options argument in Chainable.env()?

[kuzjka]

As the doc says, env() command has an optional second argument options.
However, with typescript I have an error, because cy object is effectively an implementation of Chainable, and its interface does not have this argument, see sources:

cypress/cli/types/cypress.d.ts

Lines 2236 to 2253 in 6ff266f

	/**
	* Gets multiple environment variables.
	* @see https://on.cypress.io/env
	* @example
	* cy.env(['KEY_1', 'KEY_2']).then(({ KEY_1, KEY_2 }) => { ... })
	*/
	env(keys: string[]): Chainable<Record<string, any>>
	/**
	* Gets multiple environment variables with a specific type.
	* @see https://on.cypress.io/env
	* @example
	* cy.env<{ KEY_1: string, KEY_2: number }>(['KEY_1', 'KEY_2']).then(({ KEY_1, KEY_2 }) => {
	* expect(KEY_1).to.be.a('string')
	* expect(KEY_2).to.be.a('number')
	* })
	*/
	env<T extends object>(keys: string[]): Chainable<T>

Actual error:

Type error: Expected 1 arguments, but got 2.

> 59 |       return cy.env(["varName"], { log: false }).then(/* ... */)

Is there something I am missing?

[sueun-dev]

So the cy.env() command implementation does take options: packages/driver/src/cy/commands/env.ts has env (envVars, userOptions: EnvOptions = {}) and reads options.log / options.timeout, and the docs list cy.env(keys, options). The problem is cli/types/cypress.d.ts only ships env(keys: string[]) overloads, so tsc gives you Expected 1 arguments, but got 2 even though the call is fine at runtime.

I reproduced it on 15.18.1: cy.env(["v"], { log: false }) fails typecheck. A small local augment clears it while the runtime still honors { log: false }:

declare namespace Cypress {
  interface Chainable {
    env(keys: string[], options: Partial<Cypress.Loggable & Cypress.Timeoutable>): Chainable<Record<string, any>>
  }
}

Probably worth filing as a types bug so the .d.ts overloads match the command.

[kuzjka]

@sueun-dev
Thank you for the confirmation, I've opened an issue #34284 and will try to prepare a fix soon.