Logo for jsDocs.io

popsicle-retry

  • Version 4.1.0
  • Published
  • 15.5 kB
  • No dependencies
  • Apache-2.0 license

Install

npm i popsicle-retry
yarn add popsicle-retry
pnpm add popsicle-retry

Overview

Enable request retry for Popsicle

Index

Functions

Type Aliases

Namespaces

Functions

function retries

retries: (
    count?: number,
    isRetryAllowed?: typeof retryAllowed
) => (
    error: Error | undefined,
    response: CommonResponse<unknown> | undefined,
    iter: number
) => number;

  • Init a default retry function.

function retry

retry: <T extends CommonRequest, U extends CommonResponse>(
    fn: App<T, U>,
    shouldRetry?: (
        error: Error | undefined,
        response: CommonResponse | undefined,
        iter: number
    ) => number,
    preFlight?: (req: T, iter: number, origRequest: T) => T
) => App<T, U>;

  • Middleware for running retry logic.

function retryAllowed

retryAllowed: (
    error?: Error & { code?: string },
    response?: CommonResponse
) => boolean;

  • Check if the request should be attempted again.

Type Aliases

type App

type App<T extends CommonRequest, U extends CommonResponse> = (
    req: T,
    next: () => Promise<U>
) => Promise<U>;

  • Middleware signature.

Namespaces

namespace global

namespace global {}

  • Browser detection.

namespace global.NodeJS

namespace global.NodeJS {}

    interface Process

    interface Process {}

      property browser

      browser?: boolean;

        Package Files (1)

        Dependencies (0)

        No dependencies.

        Dev Dependencies (12)

        Peer Dependencies (1)

        Badge

        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/popsicle-retry.

        • Markdown
          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/popsicle-retry)
        • HTML
          <a href="https://www.jsdocs.io/package/popsicle-retry"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>