feat(docs): add client config option reference #1517
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
kuhe
reviewed
Jan 31, 2025
...script-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java
Outdated
Show resolved
Hide resolved
kuhe
requested changes
Jan 31, 2025
| @@ -254,6 +254,7 @@ private String getCommandExample(String serviceName, String configName, String c | |||
| packageName) | |||
| + String.format("// const { %s, %s } = require(\"%s\"); // CommonJS import%n", serviceName, commandName, | |||
| packageName) | |||
| + "// See AWS SDK config options: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/configuring-the-jssdk.html\n" | |||
| + String.format("const client = new %s(config);%n", serviceName) | |||
There was a problem hiding this comment.
this is smithy, we shouldn't link to AWS docs.
A preface block to the line containing the client init should be injectable by the downstream code generator. You can refer to the CodeSection interface usage in this repo on how to do that.
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.
Issue #, if available:
Description of changes:
// See AWS SDK config options: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/configuring-the-jssdk.htmlBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.