@smithy/util-waiter

Waiter Configuration

This feature allows you to configure a waiter with specific parameters such as minimum and maximum delay. The `createWaiter` function is used to create a waiter that will poll the `checkState` function until the desired state is reached.

const { createWaiter, WaiterState } = require('@smithy/util-waiter');

const waiterConfig = {
  minDelay: 2,
  maxDelay: 120,
};

const checkState = async () => {
  // Logic to check the state of the resource
  return { state: WaiterState.SUCCESS };
};

const waiter = createWaiter(waiterConfig, checkState);

waiter().then(() => console.log('Resource reached the desired state.')).catch((err) => console.error('Failed to reach the desired state:', err));

Custom Retry Logic

This feature allows you to implement custom retry logic by specifying a `retryStrategy` function in the waiter configuration. The `retryStrategy` function determines the delay between retries based on the number of attempts.

const { createWaiter, WaiterState } = require('@smithy/util-waiter');

const waiterConfig = {
  minDelay: 2,
  maxDelay: 120,
  retryStrategy: (attempt) => Math.min(2 ** attempt, 60),
};

const checkState = async () => {
  // Logic to check the state of the resource
  return { state: WaiterState.RETRY };
};

const waiter = createWaiter(waiterConfig, checkState);

waiter().then(() => console.log('Resource reached the desired state.')).catch((err) => console.error('Failed to reach the desired state:', err));