Skip to content

Commit 969d21e

Browse files
authored
docs: add type information for client config to Command examples (#1690)
* fix(docs): improve deprecatedTrait with default description * add client config option reference * add client constructor type to command docs
1 parent 6a6615c commit 969d21e

28 files changed

+56
-0
lines changed

private/my-local-model/src/commands/GetNumbersCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ export interface GetNumbersCommandOutput extends GetNumbersResponse, __MetadataB
3434
* ```javascript
3535
* import { XYZServiceClient, GetNumbersCommand } from "xyz"; // ES Modules import
3636
* // const { XYZServiceClient, GetNumbersCommand } = require("xyz"); // CommonJS import
37+
* // import type { XYZServiceClientConfig } from "xyz";
38+
* const config = {}; // type is XYZServiceClientConfig
3739
* const client = new XYZServiceClient(config);
3840
* const input = { // GetNumbersRequest
3941
* bigDecimal: Number("bigdecimal"),

private/smithy-rpcv2-cbor-schema/src/commands/EmptyInputOutputCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ export interface EmptyInputOutputCommandOutput extends EmptyStructure, __Metadat
3333
* ```javascript
3434
* import { RpcV2ProtocolClient, EmptyInputOutputCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
3535
* // const { RpcV2ProtocolClient, EmptyInputOutputCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
36+
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
37+
* const config = {}; // type is RpcV2ProtocolClientConfig
3638
* const client = new RpcV2ProtocolClient(config);
3739
* const input = {};
3840
* const command = new EmptyInputOutputCommand(input);

private/smithy-rpcv2-cbor-schema/src/commands/Float16Command.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ export interface Float16CommandOutput extends Float16Output, __MetadataBearer {}
3333
* ```javascript
3434
* import { RpcV2ProtocolClient, Float16Command } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
3535
* // const { RpcV2ProtocolClient, Float16Command } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
36+
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
37+
* const config = {}; // type is RpcV2ProtocolClientConfig
3638
* const client = new RpcV2ProtocolClient(config);
3739
* const input = {};
3840
* const command = new Float16Command(input);

private/smithy-rpcv2-cbor-schema/src/commands/FractionalSecondsCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ export interface FractionalSecondsCommandOutput extends FractionalSecondsOutput,
3333
* ```javascript
3434
* import { RpcV2ProtocolClient, FractionalSecondsCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
3535
* // const { RpcV2ProtocolClient, FractionalSecondsCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
36+
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
37+
* const config = {}; // type is RpcV2ProtocolClientConfig
3638
* const client = new RpcV2ProtocolClient(config);
3739
* const input = {};
3840
* const command = new FractionalSecondsCommand(input);

private/smithy-rpcv2-cbor-schema/src/commands/GreetingWithErrorsCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ export interface GreetingWithErrorsCommandOutput extends GreetingWithErrorsOutpu
3939
* ```javascript
4040
* import { RpcV2ProtocolClient, GreetingWithErrorsCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
4141
* // const { RpcV2ProtocolClient, GreetingWithErrorsCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
42+
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
43+
* const config = {}; // type is RpcV2ProtocolClientConfig
4244
* const client = new RpcV2ProtocolClient(config);
4345
* const input = {};
4446
* const command = new GreetingWithErrorsCommand(input);

private/smithy-rpcv2-cbor-schema/src/commands/NoInputOutputCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ export interface NoInputOutputCommandOutput extends __MetadataBearer {}
3232
* ```javascript
3333
* import { RpcV2ProtocolClient, NoInputOutputCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
3434
* // const { RpcV2ProtocolClient, NoInputOutputCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
35+
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
36+
* const config = {}; // type is RpcV2ProtocolClientConfig
3537
* const client = new RpcV2ProtocolClient(config);
3638
* const input = {};
3739
* const command = new NoInputOutputCommand(input);

private/smithy-rpcv2-cbor-schema/src/commands/OperationWithDefaultsCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ export interface OperationWithDefaultsCommandOutput extends OperationWithDefault
3333
* ```javascript
3434
* import { RpcV2ProtocolClient, OperationWithDefaultsCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
3535
* // const { RpcV2ProtocolClient, OperationWithDefaultsCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
36+
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
37+
* const config = {}; // type is RpcV2ProtocolClientConfig
3638
* const client = new RpcV2ProtocolClient(config);
3739
* const input = { // OperationWithDefaultsInput
3840
* defaults: { // Defaults

private/smithy-rpcv2-cbor-schema/src/commands/OptionalInputOutputCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ export interface OptionalInputOutputCommandOutput extends SimpleStructure, __Met
3333
* ```javascript
3434
* import { RpcV2ProtocolClient, OptionalInputOutputCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
3535
* // const { RpcV2ProtocolClient, OptionalInputOutputCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
36+
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
37+
* const config = {}; // type is RpcV2ProtocolClientConfig
3638
* const client = new RpcV2ProtocolClient(config);
3739
* const input = { // SimpleStructure
3840
* value: "STRING_VALUE",

private/smithy-rpcv2-cbor-schema/src/commands/RecursiveShapesCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ export interface RecursiveShapesCommandOutput extends RecursiveShapesInputOutput
3333
* ```javascript
3434
* import { RpcV2ProtocolClient, RecursiveShapesCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
3535
* // const { RpcV2ProtocolClient, RecursiveShapesCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
36+
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
37+
* const config = {}; // type is RpcV2ProtocolClientConfig
3638
* const client = new RpcV2ProtocolClient(config);
3739
* const input = { // RecursiveShapesInputOutput
3840
* nested: { // RecursiveShapesInputOutputNested1

private/smithy-rpcv2-cbor-schema/src/commands/RpcV2CborDenseMapsCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ export interface RpcV2CborDenseMapsCommandOutput extends RpcV2CborDenseMapsInput
3232
* ```javascript
3333
* import { RpcV2ProtocolClient, RpcV2CborDenseMapsCommand } from "@smithy/smithy-rpcv2-cbor-schema"; // ES Modules import
3434
* // const { RpcV2ProtocolClient, RpcV2CborDenseMapsCommand } = require("@smithy/smithy-rpcv2-cbor-schema"); // CommonJS import
35+
* // import type { RpcV2ProtocolClientConfig } from "@smithy/smithy-rpcv2-cbor-schema";
36+
* const config = {}; // type is RpcV2ProtocolClientConfig
3537
* const client = new RpcV2ProtocolClient(config);
3638
* const input = { // RpcV2CborDenseMapsInputOutput
3739
* denseStructMap: { // DenseStructMap

0 commit comments

Comments
 (0)