From cfc1935a397a2fd66e04f9b51f02c0ce76cb171d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Eduardo=20Bou=C3=A7as?= <mail@eduardoboucas.com>
Date: Tue, 18 Jun 2024 11:51:14 +0100
Subject: [PATCH] feat: add `excludedPath` property

---
 src/function/v2.ts | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/src/function/v2.ts b/src/function/v2.ts
index 45ddc4c2..55f6f258 100644
--- a/src/function/v2.ts
+++ b/src/function/v2.ts
@@ -30,6 +30,15 @@ interface BaseConfig {
 }
 
 interface ConfigWithPath extends BaseConfig {
+  /**
+   * One or more URL paths for which the function will not run, even if they
+   * match a path defined with the `path` property. Paths must begin with a
+   * forward slash.
+   *
+   * {@link} https://ntl.fyi/func-routing
+   */
+  excludedPath?: Path | Path[]
+
   /**
    * One or more URL paths for which the function will run. Paths must begin
    * with a forward slash.
@@ -38,10 +47,21 @@ interface ConfigWithPath extends BaseConfig {
    */
   path?: Path | Path[]
 
+  /**
+   * The `schedule` property cannot be used when `path` is used.
+   */
   schedule?: never
 }
 
 interface ConfigWithSchedule extends BaseConfig {
+  /**
+   * The `excludedPath` property cannot be used when `schedule` is used.
+   */
+  excludedPath?: never
+
+  /**
+   * The `path` property cannot be used when `schedule` is used.
+   */
   path?: never
 
   /**