refactor(async-utils): rename timeoutSignal to timeoutController

testing-library · Aug 31, 2021 · 4a6a8d5 · 4a6a8d5
1 parent 42efb8c
commit 4a6a8d5
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 11 deletions.
diff --git a/src/core/asyncUtils.ts b/src/core/asyncUtils.ts
@@ -7,7 +7,7 @@ import {
   AsyncUtils
 } from '../types'
 
-import { createTimeoutSignal } from '../helpers/createTimeoutSignal'
+import { createTimeoutController } from '../helpers/createTimeoutController'
 import { TimeoutError } from '../helpers/error'
 
 const DEFAULT_INTERVAL = 50
@@ -20,11 +20,11 @@ function asyncUtils(act: Act, addResolver: (callback: () => void) => void): Asyn
       return callbackResult ?? callbackResult === undefined
     }
 
-    const timeoutSignal = createTimeoutSignal(timeout)
+    const timeoutSignal = createTimeoutController(timeout)
 
     const waitForResult = async () => {
       while (true) {
-        const intervalSignal = createTimeoutSignal(interval)
+        const intervalSignal = createTimeoutController(interval)
         timeoutSignal.onTimeout(() => intervalSignal.cancel())
 
         await intervalSignal.wrap(new Promise<void>(addResolver))

diff --git a/src/helpers/createTimeoutSignal.ts → src/helpers/createTimeoutController.ts b/src/helpers/createTimeoutSignal.ts → src/helpers/createTimeoutController.ts
@@ -1,21 +1,21 @@
 import { WaitOptions } from '../types'
 
-function createTimeoutSignal(timeout: WaitOptions['timeout']) {
+function createTimeoutController(timeout: WaitOptions['timeout']) {
   let timeoutId: NodeJS.Timeout
   const timeoutCallbacks: Array<() => void> = []
 
-  const timeoutSignal = {
+  const timeoutController = {
     onTimeout(callback: () => void) {
       timeoutCallbacks.push(callback)
     },
     wrap(promise: Promise<void>) {
       return new Promise<void>((resolve, reject) => {
-        timeoutSignal.timedOut = false
-        timeoutSignal.onTimeout(resolve)
+        timeoutController.timedOut = false
+        timeoutController.onTimeout(resolve)
 
         if (timeout) {
           timeoutId = setTimeout(() => {
-            timeoutSignal.timedOut = true
+            timeoutController.timedOut = true
             timeoutCallbacks.forEach((callback) => callback())
             resolve()
           }, timeout)
@@ -24,7 +24,7 @@ function createTimeoutSignal(timeout: WaitOptions['timeout']) {
         promise
           .then(resolve)
           .catch(reject)
-          .finally(() => timeoutSignal.cancel())
+          .finally(() => timeoutController.cancel())
       })
     },
     cancel() {
@@ -33,7 +33,7 @@ function createTimeoutSignal(timeout: WaitOptions['timeout']) {
     timedOut: false
   }
 
-  return timeoutSignal
+  return timeoutController
 }
 
-export { createTimeoutSignal }
+export { createTimeoutController }