Improve readability of timeout parameter

pheyos · pheyos · commit 9be14de3ff0c · 2023-05-04T16:07:09.000+02:00
diff --git a/test/functional/services/toasts.ts b/test/functional/services/toasts.ts
@@ -73,7 +73,7 @@ export class ToastsService extends FtrService {
 
   public async assertToastCount(expectedCount: number) {
     await this.retry.tryForTime(5 * 1000, async () => {
-      const toastCount = await this.getToastCount(1000);
+      const toastCount = await this.getToastCount({ timeout: 1000 });
       expect(toastCount).to.eql(
         expectedCount,
         `Toast count should be ${expectedCount} (got ${toastCount})`
@@ -96,13 +96,13 @@ export class ToastsService extends FtrService {
     return await list.findAllByCssSelector(`.euiToast`);
   }
 
-  private async getGlobalToastList(timeout?: number) {
-    return await this.testSubjects.find('globalToastList', timeout);
+  private async getGlobalToastList(options?: { timeout?: number }) {
+    return await this.testSubjects.find('globalToastList', options?.timeout);
   }
 
-  public async getToastCount(timeout?: number) {
-    const list = await this.getGlobalToastList(timeout);
-    const toasts = await list.findAllByCssSelector(`.euiToast`, timeout);
+  public async getToastCount(options?: { timeout?: number }) {
+    const list = await this.getGlobalToastList(options);
+    const toasts = await list.findAllByCssSelector(`.euiToast`, options?.timeout);
     return toasts.length;
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ export class ToastsService extends FtrService {`
`73`	`73`
`74`	`74`	`public async assertToastCount(expectedCount: number) {`
`75`	`75`	`await this.retry.tryForTime(5 * 1000, async () => {`
`76`		`- const toastCount = await this.getToastCount(1000);`
	`76`	`+ const toastCount = await this.getToastCount({ timeout: 1000 });`
`77`	`77`	`expect(toastCount).to.eql(`
`78`	`78`	`expectedCount,`
`79`	`79`	`Toast count should be ${expectedCount} (got ${toastCount})`
`@@ -96,13 +96,13 @@ export class ToastsService extends FtrService {`
`96`	`96`	return await list.findAllByCssSelector(`.euiToast`);
`97`	`97`	`}`
`98`	`98`
`99`		`- private async getGlobalToastList(timeout?: number) {`
`100`		`- return await this.testSubjects.find('globalToastList', timeout);`
	`99`	`+ private async getGlobalToastList(options?: { timeout?: number }) {`
	`100`	`+ return await this.testSubjects.find('globalToastList', options?.timeout);`
`101`	`101`	`}`
`102`	`102`
`103`		`- public async getToastCount(timeout?: number) {`
`104`		`- const list = await this.getGlobalToastList(timeout);`
`105`		- const toasts = await list.findAllByCssSelector(`.euiToast`, timeout);
	`103`	`+ public async getToastCount(options?: { timeout?: number }) {`
	`104`	`+ const list = await this.getGlobalToastList(options);`
	`105`	+ const toasts = await list.findAllByCssSelector(`.euiToast`, options?.timeout);
`106`	`106`	`return toasts.length;`
`107`	`107`	`}`
`108`	`108`	`}`