Skip to content

docs(clients): annotate internal configs and hide internal APIs #2388

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

Merged
merged 5 commits into from
May 14, 2021
Merged

docs(clients): annotate internal configs and hide internal APIs #2388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
06f01b0
feat(clients): annotate internal client configs
AllanZhengYP May 9, 2021
ff5c77d
docs(clients): add documentation for all resolved config entries
AllanZhengYP May 12, 2021
bb6f641
fix(api-reference): group command and IO types correctly
AllanZhengYP May 12, 2021
ad22085
docs(clients): strip docs for internal API or test files
AllanZhengYP May 12, 2021
5176655
docs(clients): annotate internal configs
AllanZhengYP May 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
21 changes: 16 additions & 5 deletions clients/client-accessanalyzer/AccessAnalyzerClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,46 +170,55 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
/**
* A constructor for a class implementing the @aws-sdk/types.Hash interface
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
* @internal
*/
sha256?: __HashConstructor;

/**
* The function that will be used to convert strings into HTTP endpoints.
* @internal
*/
urlParser?: __UrlParser;

/**
* A function that can calculate the length of a request body.
* @internal
*/
bodyLengthChecker?: (body: any) => number | undefined;

/**
* A function that converts a stream into an array of bytes.
* @internal
*/
streamCollector?: __StreamCollector;

/**
* The function that will be used to convert a base64-encoded string to a byte array
* The function that will be used to convert a base64-encoded string to a byte array.
* @internal
*/
base64Decoder?: __Decoder;

/**
* The function that will be used to convert binary data to a base64-encoded string
* The function that will be used to convert binary data to a base64-encoded string.
* @internal
*/
base64Encoder?: __Encoder;

/**
* The function that will be used to convert a UTF8-encoded string to a byte array
* The function that will be used to convert a UTF8-encoded string to a byte array.
* @internal
*/
utf8Decoder?: __Decoder;

/**
* The function that will be used to convert binary data to a UTF-8 encoded string
* The function that will be used to convert binary data to a UTF-8 encoded string.
* @internal
*/
utf8Encoder?: __Encoder;

/**
* The runtime environment
* The runtime environment.
* @internal
*/
runtime?: string;

Expand Down Expand Up @@ -242,11 +251,13 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__

/**
* Default credentials provider; Not available in browser runtime.
* @internal
*/
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;

/**
* Fetch related hostname, signing name or signing region with given region.
* @internal
*/
regionInfoProvider?: RegionInfoProvider;

Expand Down
3 changes: 2 additions & 1 deletion clients/client-accessanalyzer/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@
"outDir": "dist/cjs"
},
"typedocOptions": {
"exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
"exclude": ["**/node_modules/**", "**/*.spec.ts", "**/protocols/*.ts", "**/e2e/*.ts", "**/endpoints.ts"],
"excludeNotExported": true,
"excludePrivate": true,
"hideGenerator": true,
"ignoreCompilerErrors": true,
"includeDeclarations": true,
"stripInternal": true,
"readme": "./README.md",
"mode": "file",
"out": "./docs",
Expand Down
21 changes: 16 additions & 5 deletions clients/client-acm-pca/ACMPCAClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,46 +170,55 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
/**
* A constructor for a class implementing the @aws-sdk/types.Hash interface
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
* @internal
*/
sha256?: __HashConstructor;

/**
* The function that will be used to convert strings into HTTP endpoints.
* @internal
*/
urlParser?: __UrlParser;

/**
* A function that can calculate the length of a request body.
* @internal
*/
bodyLengthChecker?: (body: any) => number | undefined;

/**
* A function that converts a stream into an array of bytes.
* @internal
*/
streamCollector?: __StreamCollector;

/**
* The function that will be used to convert a base64-encoded string to a byte array
* The function that will be used to convert a base64-encoded string to a byte array.
* @internal
*/
base64Decoder?: __Decoder;

/**
* The function that will be used to convert binary data to a base64-encoded string
* The function that will be used to convert binary data to a base64-encoded string.
* @internal
*/
base64Encoder?: __Encoder;

/**
* The function that will be used to convert a UTF8-encoded string to a byte array
* The function that will be used to convert a UTF8-encoded string to a byte array.
* @internal
*/
utf8Decoder?: __Decoder;

/**
* The function that will be used to convert binary data to a UTF-8 encoded string
* The function that will be used to convert binary data to a UTF-8 encoded string.
* @internal
*/
utf8Encoder?: __Encoder;

/**
* The runtime environment
* The runtime environment.
* @internal
*/
runtime?: string;

Expand Down Expand Up @@ -242,11 +251,13 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__

/**
* Default credentials provider; Not available in browser runtime.
* @internal
*/
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;

/**
* Fetch related hostname, signing name or signing region with given region.
* @internal
*/
regionInfoProvider?: RegionInfoProvider;

Expand Down
3 changes: 2 additions & 1 deletion clients/client-acm-pca/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@
"outDir": "dist/cjs"
},
"typedocOptions": {
"exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
"exclude": ["**/node_modules/**", "**/*.spec.ts", "**/protocols/*.ts", "**/e2e/*.ts", "**/endpoints.ts"],
"excludeNotExported": true,
"excludePrivate": true,
"hideGenerator": true,
"ignoreCompilerErrors": true,
"includeDeclarations": true,
"stripInternal": true,
"readme": "./README.md",
"mode": "file",
"out": "./docs",
Expand Down
21 changes: 16 additions & 5 deletions clients/client-acm/ACMClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,46 +131,55 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
/**
* A constructor for a class implementing the @aws-sdk/types.Hash interface
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
* @internal
*/
sha256?: __HashConstructor;

/**
* The function that will be used to convert strings into HTTP endpoints.
* @internal
*/
urlParser?: __UrlParser;

/**
* A function that can calculate the length of a request body.
* @internal
*/
bodyLengthChecker?: (body: any) => number | undefined;

/**
* A function that converts a stream into an array of bytes.
* @internal
*/
streamCollector?: __StreamCollector;

/**
* The function that will be used to convert a base64-encoded string to a byte array
* The function that will be used to convert a base64-encoded string to a byte array.
* @internal
*/
base64Decoder?: __Decoder;

/**
* The function that will be used to convert binary data to a base64-encoded string
* The function that will be used to convert binary data to a base64-encoded string.
* @internal
*/
base64Encoder?: __Encoder;

/**
* The function that will be used to convert a UTF8-encoded string to a byte array
* The function that will be used to convert a UTF8-encoded string to a byte array.
* @internal
*/
utf8Decoder?: __Decoder;

/**
* The function that will be used to convert binary data to a UTF-8 encoded string
* The function that will be used to convert binary data to a UTF-8 encoded string.
* @internal
*/
utf8Encoder?: __Encoder;

/**
* The runtime environment
* The runtime environment.
* @internal
*/
runtime?: string;

Expand Down Expand Up @@ -203,11 +212,13 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__

/**
* Default credentials provider; Not available in browser runtime.
* @internal
*/
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;

/**
* Fetch related hostname, signing name or signing region with given region.
* @internal
*/
regionInfoProvider?: RegionInfoProvider;

Expand Down
3 changes: 2 additions & 1 deletion clients/client-acm/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@
"outDir": "dist/cjs"
},
"typedocOptions": {
"exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
"exclude": ["**/node_modules/**", "**/*.spec.ts", "**/protocols/*.ts", "**/e2e/*.ts", "**/endpoints.ts"],
"excludeNotExported": true,
"excludePrivate": true,
"hideGenerator": true,
"ignoreCompilerErrors": true,
"includeDeclarations": true,
"stripInternal": true,
"readme": "./README.md",
"mode": "file",
"out": "./docs",
Expand Down
21 changes: 16 additions & 5 deletions clients/client-alexa-for-business/AlexaForBusinessClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,46 +458,55 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
/**
* A constructor for a class implementing the @aws-sdk/types.Hash interface
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
* @internal
*/
sha256?: __HashConstructor;

/**
* The function that will be used to convert strings into HTTP endpoints.
* @internal
*/
urlParser?: __UrlParser;

/**
* A function that can calculate the length of a request body.
* @internal
*/
bodyLengthChecker?: (body: any) => number | undefined;

/**
* A function that converts a stream into an array of bytes.
* @internal
*/
streamCollector?: __StreamCollector;

/**
* The function that will be used to convert a base64-encoded string to a byte array
* The function that will be used to convert a base64-encoded string to a byte array.
* @internal
*/
base64Decoder?: __Decoder;

/**
* The function that will be used to convert binary data to a base64-encoded string
* The function that will be used to convert binary data to a base64-encoded string.
* @internal
*/
base64Encoder?: __Encoder;

/**
* The function that will be used to convert a UTF8-encoded string to a byte array
* The function that will be used to convert a UTF8-encoded string to a byte array.
* @internal
*/
utf8Decoder?: __Decoder;

/**
* The function that will be used to convert binary data to a UTF-8 encoded string
* The function that will be used to convert binary data to a UTF-8 encoded string.
* @internal
*/
utf8Encoder?: __Encoder;

/**
* The runtime environment
* The runtime environment.
* @internal
*/
runtime?: string;

Expand Down Expand Up @@ -530,11 +539,13 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__

/**
* Default credentials provider; Not available in browser runtime.
* @internal
*/
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;

/**
* Fetch related hostname, signing name or signing region with given region.
* @internal
*/
regionInfoProvider?: RegionInfoProvider;

Expand Down
3 changes: 2 additions & 1 deletion clients/client-alexa-for-business/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@
"outDir": "dist/cjs"
},
"typedocOptions": {
"exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
"exclude": ["**/node_modules/**", "**/*.spec.ts", "**/protocols/*.ts", "**/e2e/*.ts", "**/endpoints.ts"],
"excludeNotExported": true,
"excludePrivate": true,
"hideGenerator": true,
"ignoreCompilerErrors": true,
"includeDeclarations": true,
"stripInternal": true,
"readme": "./README.md",
"mode": "file",
"out": "./docs",
Expand Down
Loading