Skip to content

feat(docs): add client config option reference #1517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+1 −0
Open

feat(docs): add client config option reference #1517

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07533e5
feat(docs): add client config option reference
aBurmeseDev Jan 30, 2025
fa86b5b
move comment above client config
aBurmeseDev Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

we could replace config with {} so at least there would be no question about an undefined variable.

Copy link
Contributor

Choose a reason for hiding this comment

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

instead of a link, there could be a comment saying that the exported type of the config is the client class name plus the word "Config".

e.g.

import { S3Client, S3ClientConfig } from "@aws-sdk/client-s3";

+ String.format("const input = %s%n",
StructureExampleGenerator.generateStructuralHintDocumentation(
Expand Down