Skip to content

Commit 3cb4596

Browse files
committed
docs: fix various tsdoc tags
1 parent ed1ced6 commit 3cb4596

File tree

5 files changed

+7
-4
lines changed

5 files changed

+7
-4
lines changed

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/middleware-bucket-endpoint/src/bucketHostnameUtils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ export const validateNoFIPS = (useFipsEndpoint?: boolean) => {
249249

250250
/**
251251
* Validate the multi-region access point alias.
252-
* @private
252+
* @internal
253253
*/
254254
export const validateMrapAlias = (name: string) => {
255255
try {

packages/middleware-user-agent/src/user-agent-middleware.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ export const userAgentMiddleware =
9999
/**
100100
* Escape the each pair according to https://tools.ietf.org/html/rfc5234 and join the pair with pattern `name/version`.
101101
* User agent name may include prefix like `md/`, `api/`, `os/` etc., we should not escape the `/` after the prefix.
102-
* @private
102+
* @internal
103103
*/
104104
const escapeUserAgent = (userAgentPair: UserAgentPair): string => {
105105
const name = userAgentPair[0]

packages/token-providers/src/fromStatic.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ export interface FromStaticInit extends CredentialProviderOptions {
77

88
/**
99
* Creates a token provider that will read from static token.
10+
* @public
1011
*/
1112
export const fromStatic =
1213
({ token, logger }: FromStaticInit): TokenIdentityProvider =>

packages/xhr-http-handler/src/xhr-http-handler.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ export class XhrHttpHandler extends EventEmitter implements HttpHandler<XhrHttpH
282282

283283
/**
284284
* Used to omit headers that will be ignored by XHR to prevent excessive logging.
285-
* @private
285+
* @internal
286286
*/
287287
const isForbiddenRequestHeader = (header: string): boolean => {
288288
header = header.toLowerCase();
@@ -296,7 +296,7 @@ const isForbiddenRequestHeader = (header: string): boolean => {
296296
};
297297

298298
/**
299-
* @private
299+
* @internal
300300
*/
301301
const forbiddenHeaders = [
302302
"Accept-Charset",

0 commit comments

Comments
 (0)