docs: add JSDoc to and list out all available builtin middleware functions in the docs #2136
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…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
reviewed
Jun 17, 2024
| @@ -288,6 +288,11 @@ export function matchEventType(pattern: EventTypePattern): Middleware<SlackEvent | |||
| }; | |||
| } | |||
|
|
|||
| // 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.
WilliamBergamin
approved these changes
Jun 17, 2024
|
@seratch I've split the built-in middleware list into global vs. listener lists; let me know what you think 🙇 |
seratch
approved these changes
Jun 17, 2024
This was referenced Sep 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just adding some JSdocs to the available builtin middleware docs. Also added a list of them to the actual docs site.
This fixes #242 .