-
Notifications
You must be signed in to change notification settings - Fork 173
docs(event-handler): general improvements #4517
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
|
||
!!! note "Coming soon" | ||
Please [open an issue](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new/choose){target="_blank"} if you would like us to prioritize this feature. | ||
You can use the `errorHandler()` method as higher-order function or class method decorator to define a custom error handler for errors thrown in your route handlers or middleware. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can use the `errorHandler()` method as higher-order function or class method decorator to define a custom error handler for errors thrown in your route handlers or middleware. | |
You can use the `errorHandler()` method as a higher-order function or class method decorator to define a custom error handler for errors thrown in your route handlers or middleware. |
!!! note "Coming soon" | ||
Please [open an issue](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new/choose) if you would like us to prioritize this feature. | ||
|
||
As applications grow and the number of routes a Lambda function handles increases, it becomes natural to either break into smaller Lambda functions or split routes into separate files to ease maintenance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As applications grow and the number of routes a Lambda function handles increases, it becomes natural to either break into smaller Lambda functions or split routes into separate files to ease maintenance. | |
As applications grow and the number of routes a Lambda function handles increases, it becomes natural to either break it into smaller Lambda functions or split routes into separate files to ease maintenance. |
Two very minor comments but other than that LGTM! |
Summary
Changes
This PR improves the Event Handler docs by adding descriptions and examples for all features currently supported, as well as providing some light descriptions - and in some cases workarounds - for features we don't support yet. For the latter, I also link to the relevant issue so that readers can follow along with the progress.
For the most part, except a couple minor cases, the code examples reflect the current state of the Event Handler. There are however at least 2 code snippets that currently have linting issues which will be solved by issues we're already working on early next/this week.
In cases where features we added like compression and cors made the examples obsolete, I took the liberty to update the code examples with new content.
I suggest reviewers to pull the branch and run the docs locally to review effectively.
Issue number: closes #4475
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.