Let's keep only setDefaultOptions and deprecated setOptions

Author: dprevost-LMI

src/index.ts

@@ -51,6 +51,7 @@ Object.defineProperty(expectWithSoft, 'clearSoftFailures', {
 
 export const expect = expectWithSoft
 
+// TODO one day to rename to something more aligned with setDefaultOptions
 export const getConfig = (): ExpectWebdriverIO.DefaultOptions => DEFAULT_OPTIONS
 export const setDefaultOptions = (options: Partial<ExpectWebdriverIO.DefaultOptions>): void => {
     Object.entries(options).forEach(([key, value]) => {
@@ -62,6 +63,10 @@ export const setDefaultOptions = (options: Partial<ExpectWebdriverIO.DefaultOpti
         })
     })
 }
+
+/**
+ * @deprecated use setDefaultOptions instead
+ */
 export const setOptions = setDefaultOptions
 
 /**

test/matchers/element/toBeDisplayed.test.ts

@@ -198,7 +198,7 @@ Received: "not displayed"`
         let el: ChainablePromiseElement
 
         beforeEach(async () => {
-            // Reset to known state before each test
+            // Set global options to custom values before each test
             setOptions({ wait: 99, interval: 101 })
             el = await $('sel')
             el.isDisplayed = vi.fn().mockResolvedValue(true)

test/options.test.ts

@@ -1,19 +1,15 @@
-import { test, expect, describe, beforeEach, afterEach } from 'vitest'
-import { setOptions } from '../src/index.js'
+import { test, expect, describe, afterEach } from 'vitest'
+import { setDefaultOptions, setOptions } from '../src/index.js'
 import { DEFAULT_OPTIONS, DEFAULT_OPTIONS_TO_BE_DISPLAYED } from '../src/constants.js'
 
 describe('setDefaultOptions', () => {
     const defaultOptions = { ...DEFAULT_OPTIONS }
-    beforeEach(() => {
-        // Set global options to custom values before each test
-        setOptions({ wait: 2000, interval: 100 })
-    })
     afterEach(() => {
         // Reset global options to default values after each test
         setOptions(defaultOptions)
     })
 
-    test('setDefaultOptions should update both DEFAULT_OPTIONS_TO_BE_DISPLAYED and DEFAULT_OPTIONS', () => {
+    test('setOptions should update both DEFAULT_OPTIONS_TO_BE_DISPLAYED and DEFAULT_OPTIONS', () => {
         expect(DEFAULT_OPTIONS_TO_BE_DISPLAYED.wait).not.toBe(1234)
         expect(DEFAULT_OPTIONS.wait).not.toBe(1234)
 
@@ -22,5 +18,15 @@ describe('setDefaultOptions', () => {
         expect(DEFAULT_OPTIONS_TO_BE_DISPLAYED.wait).toBe(1234)
         expect(DEFAULT_OPTIONS.wait).toBe(1234)
     })
+
+    test('setDefaultOptions should update both DEFAULT_OPTIONS_TO_BE_DISPLAYED and DEFAULT_OPTIONS', () => {
+        expect(DEFAULT_OPTIONS_TO_BE_DISPLAYED.wait).not.toBe(1234)
+        expect(DEFAULT_OPTIONS.wait).not.toBe(1234)
+
+        setDefaultOptions({ wait: 1234 })
+
+        expect(DEFAULT_OPTIONS_TO_BE_DISPLAYED.wait).toBe(1234)
+        expect(DEFAULT_OPTIONS.wait).toBe(1234)
+    })
 })