Add timeout to debounce (#467)

Adds maximum timeouts to debounces in function configuration. - [x] Added a [docs PR](https://github.com/inngest/website) that references this PR - [x] Added unit/integration tests - [x] Added changesets if applicable
inngest · Jan 16, 2024 · ca93ef8 · ca93ef8
1 parent ecde5b6
commit ca93ef8
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/.changeset/ten-mayflies-count.md b/.changeset/ten-mayflies-count.md
@@ -0,0 +1,5 @@
+---
+"inngest": minor
+---
+
+Add timeouts to debounce configuration
diff --git a/packages/inngest/etc/inngest.api.md b/packages/inngest/etc/inngest.api.md
diff --git a/packages/inngest/src/types.ts b/packages/inngest/src/types.ts
@@ -877,6 +877,16 @@ export interface FunctionOptions<
      * information.
      */
     period: TimeStr;
+
+    /**
+     * The maximum time that a debounce can be extended before running.
+     * If events are continually received within the given period, a function
+     * will always run after the given timeout period.
+     *
+     * See [Debounce documentation](https://innge.st/debounce) for more
+     * information.
+     */
+    timeout?: TimeStr;
   };
 
   /**