Skip to content

Commit 0cf7245

Browse files
authored
Update documentation and replace TODOs. (#1698)
* Update documentation and replace TODOs. * Fix prettier.
1 parent 422ac30 commit 0cf7245

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

src/v2/options.ts

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,10 +263,22 @@ export interface EventHandlerOptions extends Omit<GlobalOptions, "enforceAppChec
263263
/** Type of the event. Valid values are TODO */
264264
eventType?: string;
265265

266-
/** TODO */
266+
/**
267+
* Filters events based on exact matches on the CloudEvents attributes.
268+
*
269+
* Each key-value pair represents an attribute name and its required value for exact matching.
270+
* Events must match all specified filters to trigger the function.
271+
*/
267272
eventFilters?: Record<string, string | Expression<string>>;
268273

269-
/** TODO */
274+
/**
275+
* Filters events based on path pattern matching on the CloudEvents attributes.
276+
*
277+
* Similar to eventFilters, but supports wildcard patterns for flexible matching:
278+
* - `*` matches any single path segment
279+
* - `**` matches zero or more path segments
280+
* - `{param}` captures a path segment as a parameter
281+
*/
270282
eventFilterPathPatterns?: Record<string, string | Expression<string>>;
271283

272284
/** Whether failed executions should be delivered again. */

0 commit comments

Comments
 (0)