Skip to content

docs(lambda): document that Start accepts a Handler implementation - #654

Open
nakultt wants to merge 1 commit into
aws:mainfrom
nakultt:docs/lambda-start-handler
Open

nakultt wants to merge 1 commit into
aws:mainfrom
nakultt:docs/lambda-start-handler

Conversation

@nakultt

@nakultt nakultt commented Oct 28, 2026

Copy link
Copy Markdown

Issue #, if available: #566

Description of changes:

lambda.Start accepts any value that implements the Handler interface (reflectHandler checks for it before requiring a function), and the deprecation notice on StartHandler tells users to call lambda.Start(handler) instead. The Start doc comment, however, only described function handlers ("handler must be a function").

This updates the Start doc comment to describe the Handler form and its Invoke signature before the existing rules for function handlers. Documentation only; no behavior change.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

lambda.Start also accepts any value implementing the Handler interface,
which is what the deprecation notice on StartHandler points users to,
but the Start doc comment only described function handlers.

Fixes aws#566
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.04%. Comparing base (4111853) to head (fd3f53f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #654   +/-   ##
=======================================
  Coverage   82.04%   82.04%           
=======================================
  Files          37       37           
  Lines        1487     1487           
=======================================
  Hits         1220     1220           
  Misses        264      264           
  Partials        3        3           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants