fix: add IMethods interface for use in time module functions (#2111)

* fix: add IMethods interface for use in time module * Update CHANGELOG.md Co-authored-by: David Goss <[email protected]>
cucumber · Aug 24, 2022 · 0ac8f58 · 0ac8f58
1 parent 223e9c4
commit 0ac8f58
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,7 +9,8 @@ Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CO
 
 ## [Unreleased]
 ### Added
-- `IPublishConfig` interface for use in return type of `makePublishConfig` instead of explicit `any` ([#1648](https://github.com/cucumber/cucumber-js/pull/2106))
+- `IMethods` interface for use in `getTimestamp`, `durationBetweenTimestamps`, and `wrapPromiseWithTimeout` functions and `methods` in `time` module instead of explicit `any` ([#2111](https://github.com/cucumber/cucumber-js/pull/2111))
+- `IPublishConfig` interface for use in return type of `makePublishConfig` instead of explicit `any` ([#2106](https://github.com/cucumber/cucumber-js/pull/2106))
 
 ### Fixed
 - Add override to ensure `ansi-regex` version is `^5.0.1` ([#2114](https://github.com/cucumber/cucumber-js/pull/2114))

diff --git a/src/time.ts b/src/time.ts
@@ -1,9 +1,16 @@
 import { performance } from 'perf_hooks'
 import * as messages from '@cucumber/messages'
+import { FakeClock, GlobalTimers, TimerId } from '@sinonjs/fake-timers'
 
 let previousTimestamp: number
 
-const methods: any = {
+interface IMethods extends GlobalTimers<TimerId> {
+  beginTiming: () => void
+  endTiming: () => number
+  performance: FakeClock<TimerId>['performance']
+}
+
+const methods: Partial<IMethods> = {
   beginTiming() {
     previousTimestamp = getTimestamp()
   },
@@ -44,7 +51,7 @@ export async function wrapPromiseWithTimeout<T>(
   timeoutInMilliseconds: number,
   timeoutMessage: string = ''
 ): Promise<T> {
-  let timeoutId: NodeJS.Timeout
+  let timeoutId: TimerId
   if (timeoutMessage === '') {
     timeoutMessage = `Action did not complete within ${timeoutInMilliseconds} milliseconds`
   }