@types/retry

What is @types/retry?

The @types/retry package provides TypeScript type definitions for the 'retry' npm package, which is a utility for retrying operations that might fail. It allows developers to implement retry logic with various strategies and options, making it easier to handle transient failures in applications. The types package doesn't add functionality but offers type support for TypeScript users of 'retry'.

What are @types/retry's main functionalities?

Creating a retry operation

This feature allows you to create a retry operation. You can specify the operation you want to retry, such as a network request. The `attempt` method is used to try the operation, and `retry` is called if the operation fails, until the maximum number of attempts is reached.

import * as retry from 'retry';

const operation = retry.operation();

operation.attempt((currentAttempt) => {
  // Your operation here, e.g., a network request
  if (networkError) {
    if (operation.retry(networkError)) {
      return;
    }
    // Handle the network error after max retries
  }
});

Customizing retry options

This feature demonstrates how to customize the retry operation with specific options. You can set the maximum number of retries, the exponential backoff factor, minimum and maximum timeout between retries, and whether to randomize the retry intervals.

import * as retry from 'retry';

const operation = retry.operation({
  retries: 5, // Maximum number of attempts
  factor: 2, // The exponential factor
  minTimeout: 1 * 1000, // The number of milliseconds before starting the first retry
  maxTimeout: 60 * 1000, // The maximum number of milliseconds between two retries
  randomize: true, // Randomizes the timeouts by multiplying with a factor between 1 to 2
});

Other packages similar to @types/retry

async-retry

Similar to 'retry', 'async-retry' provides retry functionality specifically designed for asynchronous operations. It supports both promise-based and async/await syntax, making it a good alternative for modern JavaScript and TypeScript applications. Unlike @types/retry, which is just type definitions, 'async-retry' is a standalone package that doesn't require separate type definitions.

p-retry

This package is a promise-based retry library that offers a simple API for retrying operations. It is very similar to 'async-retry' but focuses more on promises. 'p-retry' is useful for applications heavily utilizing promises. It differs from @types/retry in that it's specifically designed for promise-based operations and also doesn't require separate type definitions for TypeScript users.

README

Installation

npm install --save @types/retry

Summary

This package contains type definitions for retry (https://github.com/tim-kos/node-retry).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/retry.

Additional Details

• Last updated: Wed, 18 Oct 2023 11:45:06 GMT
• Dependencies: none

Credits

These definitions were written by Stan Goldmann, and BendingBender.