UNPKG

@openmrs/esm-framework

Version:

github.com/openmrs/openmrs-esm-core

openmrs/openmrs-esm-core

84 lines (48 loc) • 2.09 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
[@openmrs/esm-framework](../API.md) / RetryOptions # Interface: RetryOptions Options for configuring the behavior of the [retry](../API.md#retry) function. ## Table of contents ### Methods - [getDelay](RetryOptions.md#getdelay) - [onError](RetryOptions.md#onerror) - [shouldRetry](RetryOptions.md#shouldretry) ## Methods ### getDelay ▸ `Optional` **getDelay**(`attempt`): `number` Calculates the next delay (in milliseconds) before a retry attempt. Returning a value for the inital attempt (`0`) delays the initial function invocation. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. | #### Returns `number` #### Defined in [packages/framework/esm-utils/src/retry.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L18) ___ ### onError ▸ `Optional` **onError**(`e`, `attempt`): `void` Called when invoking the function resulted in an error. Allows running side-effects on errors, e.g. logging. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `e` | `any` | The error thrown by the function. | | `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. | #### Returns `void` #### Defined in [packages/framework/esm-utils/src/retry.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L25) ___ ### shouldRetry ▸ `Optional` **shouldRetry**(`attempt`): `any` Determines whether the retry function should retry executing the function after it failed with an error on the current attempt. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. | #### Returns `any` #### Defined in [packages/framework/esm-utils/src/retry.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L12)