docs: add JSDoc to and list out all available builtin middleware functions in the docs#2136
docs: add JSDoc to and list out all available builtin middleware functions in the docs#2136
Conversation
…tions in the docs.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2136 +/- ##
=======================================
Coverage 82.03% 82.03%
=======================================
Files 18 18
Lines 1536 1536
Branches 442 442
=======================================
Hits 1260 1260
Misses 178 178
Partials 98 98 ☔ View full report in Codecov by Sentry. |
seratch
left a comment
seratch
left a comment
There was a problem hiding this comment.
Thanks for the work! I think the document could be clearer about which middleware is typically used for listener middleware. Technically, you can pass any middleware to any listener, but some patterns are just meaningless.
| } | ||
|
|
||
| // TODO: breaking change: why does this method have to be invoked as a function with no args, while other similar | ||
| // method like the `only*` ones do not require that? should make this consistent. |
There was a problem hiding this comment.
If we rename this to onlyNonSelfEvents or something like that, that sounds good to me too. When we make such a change, perhaps having an alias "ignoreSelf" for backward compatibility for a while would be a good way to go.
|
@seratch I've split the built-in middleware list into global vs. listener lists; let me know what you think 🙇 |
seratch
left a comment
seratch
left a comment
There was a problem hiding this comment.
Thanks for the update! Looks goo to me 👍
3 participants
Just adding some JSdocs to the available builtin middleware docs. Also added a list of them to the actual docs site.
This fixes #242 .