Skip to content

Commit f726b9c

Browse files
committed
docs: document MAX_RETRIES option for binary downloads
1 parent 27c7d71 commit f726b9c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/api/config-options.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,19 @@ Also see [ARCHIVE_NAME](#archive_name).
269269
Keep in mind that downloaded binaries will never be automatically deleted.
270270
:::
271271

272+
### MAX_RETRIES
273+
274+
| Environment Variable | PackageJson |
275+
| :------------------: | :---------: |
276+
| `MONGOMS_MAX_RETRIES` | `maxRetries` |
277+
278+
Option `MAX_RETRIES` is used to set the maximum number of retry attempts for downloading binaries when a retryable error occurs.
279+
280+
Default: `3`
281+
282+
Set this to control how many times the downloader will attempt to recover from transient errors (like network issues) before failing.
283+
284+
272285
## How to use them in the package.json
273286

274287
To use the config options in the `package.json`, they need to be camelCased (and without `_`), and need to be in the property `config.mongodbMemoryServer`

0 commit comments

Comments
 (0)