Skip to content
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.

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

docs: fix various tsdoc tags #6765

Merged
merged 1 commit into from
Dec 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions packages/credential-providers/src/createCredentialChain.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ type Mutable<Type> = {
* @param credentialProviders - one or more credential providers.
* @returns a single AwsCredentialIdentityProvider that calls the given
* providers in sequence until one succeeds or all fail.
*
* @public
*/
export const createCredentialChain = (
...credentialProviders: RuntimeConfigAwsCredentialIdentityProvider[]
Expand Down
5 changes: 5 additions & 0 deletions packages/credential-providers/src/fromCognitoIdentity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import {
FromCognitoIdentityParameters as _FromCognitoIdentityParameters,
} from "@aws-sdk/credential-provider-cognito-identity";

/**
* @public
*/
export interface FromCognitoIdentityParameters extends Omit<_FromCognitoIdentityParameters, "client"> {
/**
* Custom client configuration if you need overwrite default Cognito Identity client configuration.
Expand Down Expand Up @@ -48,6 +51,8 @@ export type CognitoIdentityCredentialProvider = _CognitoIdentityCredentialProvid
* }),
* });
* ```
*
* @public
*/
export const fromCognitoIdentity = (options: FromCognitoIdentityParameters): CognitoIdentityCredentialProvider =>
_fromCognitoIdentity({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ export interface FromCognitoIdentityPoolParameters extends Omit<_FromCognitoIden
* }),
* });
* ```
*
* @public
*/
export const fromCognitoIdentityPool = (
options: FromCognitoIdentityPoolParameters
Expand Down
2 changes: 2 additions & 0 deletions packages/credential-providers/src/fromContainerMetadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ export interface RemoteProviderInit extends _RemoteProviderInit, CredentialProvi
* }),
* });
* ```
*
* @public
*/
export const fromContainerMetadata = (init?: RemoteProviderInit): AwsCredentialIdentityProvider => {
init?.logger?.debug("@smithy/credential-provider-imds", "fromContainerMetadata");
Expand Down
2 changes: 2 additions & 0 deletions packages/credential-providers/src/fromEnv.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,7 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
* credentials: fromEnv(),
* });
* ```
*
* @public
*/
export const fromEnv = (init?: FromEnvInit): AwsCredentialIdentityProvider => _fromEnv(init);
2 changes: 2 additions & 0 deletions packages/credential-providers/src/fromIni.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ import type { RuntimeConfigAwsCredentialIdentityProvider } from "@aws-sdk/types"
* }),
* });
* ```
*
* @public
*/
export const fromIni = (init: FromIniInit = {}): RuntimeConfigAwsCredentialIdentityProvider =>
_fromIni({
Expand Down
2 changes: 2 additions & 0 deletions packages/credential-providers/src/fromInstanceMetadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
* }),
* });
* ```
*
* @public
*/
export const fromInstanceMetadata = (
init?: _RemoteProviderInit & CredentialProviderOptions
Expand Down
2 changes: 2 additions & 0 deletions packages/credential-providers/src/fromNodeProviderChain.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ import type { AwsCredentialIdentityProvider } from "@smithy/types";
* clientPlugins: [addFooHeadersPlugin],
* })
* ```
*
* @public
*/
export const fromNodeProviderChain = (init: DefaultProviderInit = {}): AwsCredentialIdentityProvider =>
defaultProvider({
Expand Down
2 changes: 2 additions & 0 deletions packages/credential-providers/src/fromProcess.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,7 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
* }),
* });
* ```
*
* @public
*/
export const fromProcess = (init?: FromProcessInit): AwsCredentialIdentityProvider => _fromProcess(init);
2 changes: 2 additions & 0 deletions packages/credential-providers/src/fromSSO.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
* }),
* });
* ```
*
* @public
*/
export const fromSSO = (init: FromSSOInit = {}): AwsCredentialIdentityProvider => {
return _fromSSO({ ...init });
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ export interface FromTemporaryCredentialsOptions extends CredentialProviderOptio
* ),
* });
* ```
*
* @public
*/
export const fromTemporaryCredentials = (options: FromTemporaryCredentialsOptions): AwsCredentialIdentityProvider => {
let stsClient: STSClient;
Expand Down
2 changes: 2 additions & 0 deletions packages/credential-providers/src/fromTokenFile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ import type { AwsCredentialIdentityProvider } from "@smithy/types";
* });
* });
* ```
*
* @public
*/
export const fromTokenFile = (init: FromTokenFileInit = {}): AwsCredentialIdentityProvider =>
_fromTokenFile({
Expand Down
2 changes: 2 additions & 0 deletions packages/credential-providers/src/fromWebToken.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ import type { AwsCredentialIdentityProvider } from "@smithy/types";
* }),
* });
* ```
*
* @public
*/
export const fromWebToken = (init: FromWebTokenInit): AwsCredentialIdentityProvider =>
_fromWebToken({
Expand Down
3 changes: 3 additions & 0 deletions packages/credential-providers/src/loadSts.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import { AssumeRoleCommand, STSClient } from "@aws-sdk/client-sts";

// This file must be loaded dynamically.
/**
* @internal
*/
export { AssumeRoleCommand, STSClient };
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ export const validateNoFIPS = (useFipsEndpoint?: boolean) => {

/**
* Validate the multi-region access point alias.
* @private
* @internal
*/
export const validateMrapAlias = (name: string) => {
try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ export const userAgentMiddleware =
/**
* Escape the each pair according to https://tools.ietf.org/html/rfc5234 and join the pair with pattern `name/version`.
* User agent name may include prefix like `md/`, `api/`, `os/` etc., we should not escape the `/` after the prefix.
* @private
* @internal
*/
const escapeUserAgent = (userAgentPair: UserAgentPair): string => {
const name = userAgentPair[0]
Expand Down
1 change: 1 addition & 0 deletions packages/token-providers/src/fromStatic.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export interface FromStaticInit extends CredentialProviderOptions {

/**
* Creates a token provider that will read from static token.
* @public
*/
export const fromStatic =
({ token, logger }: FromStaticInit): TokenIdentityProvider =>
Expand Down
4 changes: 2 additions & 2 deletions packages/xhr-http-handler/src/xhr-http-handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ export class XhrHttpHandler extends EventEmitter implements HttpHandler<XhrHttpH

/**
* Used to omit headers that will be ignored by XHR to prevent excessive logging.
* @private
* @internal
*/
const isForbiddenRequestHeader = (header: string): boolean => {
header = header.toLowerCase();
Expand All @@ -296,7 +296,7 @@ const isForbiddenRequestHeader = (header: string): boolean => {
};

/**
* @private
* @internal
*/
const forbiddenHeaders = [
"Accept-Charset",
Expand Down
Loading