Skip to content

Conversation

dreamorosi
Copy link
Contributor

Summary

Changes

Please provide a summary of what's being changed

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.

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

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.

@dreamorosi dreamorosi self-assigned this Sep 20, 2025
@pull-request-size pull-request-size bot added the size/XXL PRs with 1K+ LOC, largely documentation related label Sep 20, 2025
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Sep 20, 2025
Copy link


!!! 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

@svozza
Copy link
Contributor

svozza commented Sep 20, 2025

Two very minor comments but other than that LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XXL PRs with 1K+ LOC, largely documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: minor general improvements to Event Handler rest
2 participants