Skip to content

Commit 06300d4

Browse files
authored
docs(tsdoc): add release tags to util-waiters (#4512)
1 parent 20ec9b7 commit 06300d4

File tree

4 files changed

+20
-2
lines changed

4 files changed

+20
-2
lines changed

packages/util-waiter/src/poller.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ import { sleep } from "./utils/sleep";
22
import { WaiterOptions, WaiterResult, WaiterState } from "./waiter";
33

44
/**
5+
* @internal
6+
*
57
* Reference: https://smithy.io/2.0/additional-specs/waiters.html#waiter-retries
68
*/
79
const exponentialBackoffWithJitter = (minDelay: number, maxDelay: number, attemptCeiling: number, attempt: number) => {
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/**
2+
* @internal
3+
*/
14
export const sleep = (seconds: number) => {
25
return new Promise((resolve) => setTimeout(resolve, seconds * 1000));
36
};

packages/util-waiter/src/utils/validate.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
import { WaiterOptions } from "../waiter";
22

33
/**
4+
* @internal
5+
*
46
* Validates that waiter options are passed correctly
57
* @param options a waiter configuration object
68
*/

packages/util-waiter/src/waiter.ts

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
import { WaiterConfiguration as WaiterConfiguration__ } from "@aws-sdk/types";
22

3+
/**
4+
* @internal
5+
*/
36
export interface WaiterConfiguration<T> extends WaiterConfiguration__<T> {}
47

58
/**
6-
* @private
9+
* @internal
710
*/
811
export const waiterServiceDefaults = {
912
minDelay: 2,
1013
maxDelay: 120,
1114
};
1215

1316
/**
14-
* @private
17+
* @internal
1518
*/
1619
export type WaiterOptions<Client> = WaiterConfiguration<Client> &
1720
Required<Pick<WaiterConfiguration<Client>, "minDelay" | "maxDelay">>;
1821

22+
/**
23+
* @internal
24+
*/
1925
export enum WaiterState {
2026
ABORTED = "ABORTED",
2127
FAILURE = "FAILURE",
@@ -24,6 +30,9 @@ export enum WaiterState {
2430
TIMEOUT = "TIMEOUT",
2531
}
2632

33+
/**
34+
* @internal
35+
*/
2736
export type WaiterResult = {
2837
state: WaiterState;
2938

@@ -34,6 +43,8 @@ export type WaiterResult = {
3443
};
3544

3645
/**
46+
* @internal
47+
*
3748
* Handles and throws exceptions resulting from the waiterResult
3849
* @param result WaiterResult
3950
*/

0 commit comments

Comments
 (0)