Skip to content

Commit

Permalink
feat: add excludedPath property (#509)
Browse files Browse the repository at this point in the history
**Which problem is this pull request solving?**

Part of
https://linear.app/netlify/issue/COM-724/excludedpath-in-functions-v2.
  • Loading branch information
eduardoboucas authored Jun 20, 2024
1 parent 3529a39 commit 5c390ab
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions src/function/v2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

/**
Expand Down

0 comments on commit 5c390ab

Please sign in to comment.