# @mangar2/retry

> Helps to call functions multiple times with delays inbetween

Latest version **1.1.1** (published 2020-12-10) · LGPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install @mangar2/retry
pnpm add @mangar2/retry
yarn add @mangar2/retry
bun add @mangar2/retry
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2020-12-10 |
| First published | 2020-01-18 |
| Weekly downloads | 0 |
| License | LGPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 12.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Volker Böhm |
| Maintainers | mangar2 |
| Keywords | config, NODE_ENV |

## Links

- npm: https://www.npmjs.com/package/@mangar2/retry
- Repository: https://github.com/Mangar2/yaha/tree/master/node_modules/@mangar2/retry
- Homepage: https://github.com/Mangar2/yaha.git
- npm.io page: https://npm.io/package/@mangar2/retry

## Dependencies (1)

- [@mangar2/callbacks](https://npm.io/package/@mangar2/callbacks.md) latest

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2020-12-10
- 1.0.0 — 2020-01-18

## README

<!-- This file is generated by jsmddoc version 0.1 -->

# Abstract

asyncronously retries function calls several times with delay inbetween Prevents parallel retry loops with the same topic .

## Contents

- [Meta](#Meta)
- [Class Retry](#Class-Retry)
  - [Parameters](#Retry-Parameters)
  - [Methods](#Retry-Methods)
    - [on](#on)
    - [retry](#retry)
    - [stopRetry](#stopRetry)
    - [topicRetry](#topicRetry)

## Meta

| | |
| --- | --- |
| **File** | retry.js |
| **Abstract** | asyncronously retries function calls several times with delay inbetween Prevents parallel retry loops with the same topic . |
| **Author** | Volker Böhm |
| **Copyright** | Copyright ( c ) 2020 Volker Böhm |
| **License** | This software is licensed under the GNU LESSER GENERAL PUBLIC LICENSE Version 3 . It is furnished "as is" , without any support , and with no warranty , express or implied , as to its usefulness for any purpose . |

## Class Retry

`new Retry(immediateFirstCall)`

Class providing a retry facility calling a callback "count" times asyncronously with a delay inbetween Additionally providing a "topic" based retry ( "topicRetry" ) with the following functionality :

- Asynchronously calles a global callback "count" times with a delay inbetween
- If no global callback is provided , it calls a callback prior registrated to the topic
- If topicRetry is called with a still running existing retry loop for the same topic , this existing is terminated .

### Example

```javascript
const retry = new Retry()
// prints 5 times hello world, with a delay of 1 second between each output
retry.retry(5, 1000, () => console.log("hello world"))
// prints hello1, world, hello2, world, hello2
retry.topicRetry('hello', 2, 1000, () => console.log("hello1"))
retry.topicRetry('world', 2, 1000, () => console.log("world"))
retry.topicRetry('hello', 2, 1000, () => console.log("hello2"))
```

### Retry Parameters

| Name | Type | Attribute | Default | Description |
| ---------- | ------------ | ------------ | ------------ | ----------------- |
| `immediateFirstCall` | `boolean` | optional | true | true , if the first call should happen immediately | |

### Retry Methods

#### on

`on (topic, callback)`

Registers a callback for a topic

##### on Parameters

| Name | Type | Description |
| ---------- | ------------ | ----------------- |
| `topic` | `string` | topic to register a callback | |
| `callback` | `function(` | called on matching topic on retries | |

##### on throws

| Type | Description |
| ---- | ----------- |
| `Error` | if the callback is not 'function' |

#### retry

`async retry (count, delayInMilliseconds, callback) => {Promise}`

Calls a callback function multiple times and waits between the calls .

##### retry Parameters

| Name | Type | Description |
| ---------- | ------------ | ----------------- |
| `count` | `number` | quantity of retries | |
| `delayInMilliseconds` | `number` | amount of milliseconds to wait between retries | |
| `callback` | `function(loopNumber` | function called on each retry | |

##### retry returns

| Type | Description |
| ---- | ----------- |
| `Promise` | promise resolving , when all callbacks are done |

#### stopRetry

`stopRetry (topic)`

Stops a retry loop

##### stopRetry Parameters

| Name | Type | Description |
| ---------- | ------------ | ----------------- |
| `topic` | `string` | name of the retry topic | |

#### topicRetry

`async topicRetry (topic, count, delayInMilliseconds, callback) => {Promise}`

Calls a callback function multiple times and waits between the calls . If you call "retry" with the same topic a second time , it will stop the running retry loop with the same topic

##### topicRetry Parameters

| Name | Type | Description |
| ---------- | ------------ | ----------------- |
| `topic` | `string` | name of the topic to retry | |
| `count` | `number` | quantity of retries | |
| `delayInMilliseconds` | `number` | amount of milliseconds to wait between retries | |
| `callback` | `function(` | function called on each retry | |

##### topicRetry returns

| Type | Description |
| ---- | ----------- |
| `Promise` | promise resolving , when all callbacks are done |

---
_Source: https://npm.io/package/@mangar2/retry · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._