Skip to content

Commit 599a60f

Browse files
authored
docs: fix various tsdoc tags (aws#6765)
1 parent 5c25a5d commit 599a60f

File tree

18 files changed

+37
-4
lines changed

18 files changed

+37
-4
lines changed

packages/credential-providers/src/createCredentialChain.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ type Mutable<Type> = {
5555
* @param credentialProviders - one or more credential providers.
5656
* @returns a single AwsCredentialIdentityProvider that calls the given
5757
* providers in sequence until one succeeds or all fail.
58+
*
59+
* @public
5860
*/
5961
export const createCredentialChain = (
6062
...credentialProviders: RuntimeConfigAwsCredentialIdentityProvider[]

packages/credential-providers/src/fromCognitoIdentity.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ import {
55
FromCognitoIdentityParameters as _FromCognitoIdentityParameters,
66
} from "@aws-sdk/credential-provider-cognito-identity";
77

8+
/**
9+
* @public
10+
*/
811
export interface FromCognitoIdentityParameters extends Omit<_FromCognitoIdentityParameters, "client"> {
912
/**
1013
* Custom client configuration if you need overwrite default Cognito Identity client configuration.
@@ -48,6 +51,8 @@ export type CognitoIdentityCredentialProvider = _CognitoIdentityCredentialProvid
4851
* }),
4952
* });
5053
* ```
54+
*
55+
* @public
5156
*/
5257
export const fromCognitoIdentity = (options: FromCognitoIdentityParameters): CognitoIdentityCredentialProvider =>
5358
_fromCognitoIdentity({

packages/credential-providers/src/fromCognitoIdentityPool.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ export interface FromCognitoIdentityPoolParameters extends Omit<_FromCognitoIden
4848
* }),
4949
* });
5050
* ```
51+
*
52+
* @public
5153
*/
5254
export const fromCognitoIdentityPool = (
5355
options: FromCognitoIdentityPoolParameters

packages/credential-providers/src/fromContainerMetadata.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ export interface RemoteProviderInit extends _RemoteProviderInit, CredentialProvi
2525
* }),
2626
* });
2727
* ```
28+
*
29+
* @public
2830
*/
2931
export const fromContainerMetadata = (init?: RemoteProviderInit): AwsCredentialIdentityProvider => {
3032
init?.logger?.debug("@smithy/credential-provider-imds", "fromContainerMetadata");

packages/credential-providers/src/fromEnv.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,7 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
2424
* credentials: fromEnv(),
2525
* });
2626
* ```
27+
*
28+
* @public
2729
*/
2830
export const fromEnv = (init?: FromEnvInit): AwsCredentialIdentityProvider => _fromEnv(init);

packages/credential-providers/src/fromIni.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ import type { RuntimeConfigAwsCredentialIdentityProvider } from "@aws-sdk/types"
3939
* }),
4040
* });
4141
* ```
42+
*
43+
* @public
4244
*/
4345
export const fromIni = (init: FromIniInit = {}): RuntimeConfigAwsCredentialIdentityProvider =>
4446
_fromIni({

packages/credential-providers/src/fromInstanceMetadata.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
2424
* }),
2525
* });
2626
* ```
27+
*
28+
* @public
2729
*/
2830
export const fromInstanceMetadata = (
2931
init?: _RemoteProviderInit & CredentialProviderOptions

packages/credential-providers/src/fromNodeProviderChain.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ import type { AwsCredentialIdentityProvider } from "@smithy/types";
3131
* clientPlugins: [addFooHeadersPlugin],
3232
* })
3333
* ```
34+
*
35+
* @public
3436
*/
3537
export const fromNodeProviderChain = (init: DefaultProviderInit = {}): AwsCredentialIdentityProvider =>
3638
defaultProvider({

packages/credential-providers/src/fromProcess.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,7 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
2323
* }),
2424
* });
2525
* ```
26+
*
27+
* @public
2628
*/
2729
export const fromProcess = (init?: FromProcessInit): AwsCredentialIdentityProvider => _fromProcess(init);

packages/credential-providers/src/fromSSO.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ import { AwsCredentialIdentityProvider } from "@smithy/types";
4141
* }),
4242
* });
4343
* ```
44+
*
45+
* @public
4446
*/
4547
export const fromSSO = (init: FromSSOInit = {}): AwsCredentialIdentityProvider => {
4648
return _fromSSO({ ...init });

0 commit comments

Comments
 (0)