Maintenance: review API docs & README for Idempotency

[dreamorosi]

Summary

This issue is part of a larger group: #2381

As part of this task we should:

• review that the README file for the package is relevant for customers and follow the structure described in the parent issue
• review the API docs and apply the conventions described in the parent issue
• add a testing your code section & remove MD043 disable in docs page

Why is this needed?

So that customers finding the package on npm or using the API docs have the right level of details.

Which area does this relate to?

Other

Solution

No response

Acknowledgment

• This request meets Powertools for AWS Lambda (TypeScript) Tenets
• Should this be considered in other Powertools for AWS Lambda languages? i.e. Python, Java, and .NET

Future readers

Please react with 👍 and your use case to help us understand customer demand.

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

[github-actions]

This is now released under v2.8.0 version!