feat(logger): JSDOCS support #491
Merged
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
saragerion
changed the title
saragerion
changed the title
saragerion
added
documentation
flochaz
suggested changes
Jan 20, 2022
| @@ -1,6 +1,13 @@ | |||
| import type { Logger } from '../Logger'; | |||
| import middy from '@middy/core'; | |||
|
|
|||
| /** | |||
| * Middy middleware that adds the current Lambda invocation's context | |||
| * inside all log items. | |||
There was a problem hiding this comment.
an example can be useful here , and can will be more in line with what we have in tracer for instance: https://github.com/awslabs/aws-lambda-powertools-typescript/blob/main/packages/tracing/src/middleware/middy.ts#L15
There was a problem hiding this comment.
I agree, well spotted!
Co-authored-by: Florian Chazal <[email protected]>
dreamorosi
reviewed
Jan 20, 2022
packages/logger/src/Logger.ts
Outdated
| @@ -18,6 +18,30 @@ import type { | |||
| PowertoolLogData, | |||
| } from './types'; | |||
|
|
|||
| /** | |||
| * | |||
| * # Logger class | |||
There was a problem hiding this comment.
I'd consider removing this since once rendered there's already a heading (see image below):
| * information in all log items. | ||
| * The decorator can be used only when attached to a Lambda function handler which | ||
| * is written as method of a class, and should be declared just before the handler declaration. | ||
| * |
There was a problem hiding this comment.
Since this is a slightly more involved method perhaps we can provide a code example?
Co-authored-by: Andrea Amorosi <[email protected]>
Co-authored-by: Andrea Amorosi <[email protected]>
Co-authored-by: Andrea Amorosi <[email protected]>
Co-authored-by: Andrea Amorosi <[email protected]>
Co-authored-by: Andrea Amorosi <[email protected]>
Co-authored-by: Andrea Amorosi <[email protected]>
…s-typescript into feat/jsdocs
flochaz
approved these changes
Jan 20, 2022
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.
Description of your changes
Added support for JSDOCS: https://jsdoc.app
How to verify this change
N/A.
Related issues, RFCs
#354
PR status
Is this ready for review?: YES
Is it a breaking change?: NO
Checklist
Breaking change checklist
N/A
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.