Support timeout typings on workers/jobs:

- index.d.ts: QueueWorker typing expanded to include new supported timeout property. - index.test-d.ts: Test added for new typing support.
jessetane · Mar 19, 2019 · bb2bd74 · bb2bd74
1 parent 75e62bc
commit bb2bd74
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -161,6 +161,11 @@ export default Queue;
 
 export interface QueueWorker {
     (callback?: QueueWorkerCallback): void;
+
+    /**
+     * Override queue timeout.
+     */
+    timeout?: number;
 }
 
 export interface QueueWorkerCallback {

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -10,6 +10,11 @@ expectType<Options>({ results: [0, 'a', true, undefined, NaN] });
 expectType<QueueWorker>(() => undefined);
 expectType<QueueWorker>((callback: QueueWorkerCallback) => undefined);
 
+function withTimeout() { }
+withTimeout.timeout = 1;
+
+expectType<QueueWorker>(withTimeout);
+
 expectType<QueueWorkerCallback>(() => undefined);
 expectType<QueueWorkerCallback>((data: Error) => undefined);
 expectType<QueueWorkerCallback>((error: Error) => undefined);