fix(cypress): type fill() command as non-chainable

MTES-MCT · Feb 29, 2024 · d4b5c35 · d4b5c35
1 parent 538615f
commit d4b5c35
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 6 deletions.
diff --git a/src/cypress/commands/fill/fillDatePicker.ts b/src/cypress/commands/fill/fillDatePicker.ts
@@ -5,7 +5,7 @@ export function fillDatePicker(
   dateOrDateWithTimeTuple: Cypress.DateTuple | Cypress.DateWithTimeTuple | undefined,
   _label: string,
   force: boolean
-): void {
+) {
   Cypress.log({
     consoleProps: () => ({
       'Applied to': fieldsetElement,

diff --git a/src/cypress/commands/fill/fillDateRangePicker.ts b/src/cypress/commands/fill/fillDateRangePicker.ts
@@ -5,7 +5,7 @@ export function fillDateRangePicker(
   dateOrDateWithTimeTupleRange: Cypress.DateRangeTuple | Cypress.DateWithTimeRangeTuple | undefined,
   _label: string,
   force: boolean
-): void {
+) {
   Cypress.log({
     consoleProps: () => ({
       'Applied to': fieldsetElement,

diff --git a/src/cypress/commands/fill/index.ts b/src/cypress/commands/fill/index.ts
@@ -27,7 +27,7 @@ import { throwError } from '../../utils/throwError'
 
 let TOTAL_RETRIES: number
 
-export function fill(label: string, value: any, options: Partial<Cypress.FillOptions> = {}): void {
+export function fill(label: string, value: any, options: Partial<Cypress.FillOptions> = {}) {
   const controlledOptions = { ...DEFAULT_OPTIONS, ...options }
   if (!TOTAL_RETRIES) {
     TOTAL_RETRIES = controlledOptions.retries

diff --git a/src/cypress/global.d.ts b/src/cypress/global.d.ts
@@ -27,9 +27,10 @@ declare namespace Cypress {
     /**
      * @description
      * You can set the `retries` option to a number greater than 5 (default) to retry the action in case of failure.
-     * You can also set the `forced` option to `true` to force the action without waiting for the element to be visible.
+     * You can also set the `force` option to `true` to force the action without waiting for the element to be visible.
      *
-     * ⚠️ In order to ensure backward compatibility, the `forced` option is set to `true` by default.
+     * ⚠️ In order to ensure backward compatibility, the `force` option is set to `true` by default.
+     * This will be changed to `false` in the next major version.
      *
      * @example
      * ```ts
@@ -47,7 +48,7 @@ declare namespace Cypress {
      *   cy.fill('My Field', undefined)
      * ```
      */
-    fill(label: string, value: any, options?: Partial<FillOptions>): Chainable<Element>
+    fill(label: string, value: any, options?: Partial<FillOptions>): void
 
     forceCheck(options?: Partial<CheckOptions>): Chainable<JQuery<HTMLElement>>
     forceClear(options?: Partial<ClearOptions>): Chainable<JQuery<HTMLElement>>