Update docs for getRetryDelay()

This commit is contained in:
JonnyBurger
2025-09-30 15:03:29 +02:00
parent 548ca74c93
commit 26c1debb7a
2 changed files with 5 additions and 3 deletions
+4 -2
View File
@@ -487,7 +487,7 @@ If you're using this source in the browser and the URL is on a different origin,
```ts
type UrlSourceOptions = {
requestInit?: RequestInit;
getRetryDelay?: (previousAttempts: number) => number | null;
getRetryDelay?: (previousAttempts: number, error: unknown, url: string | URL | Request) => number | null;
// The maximum number of bytes the cache is allowed to hold
// in memory. Defaults to 8 MiB.
@@ -517,7 +517,9 @@ const source = new UrlSource('https://example.com/bigbuckbunny.mp4', {
});
```
Not setting `getRetryDelay` will default to an infinite, capped exponential backoff pattern. If a CORS error is suspected (`fetch()` did reject even though `navigator.onLine` is true), no further retries will be made.
Not setting `getRetryDelay` will lead to the default being used:
- infinite exponential backoff pattern, capped at 16 seconds.
- If a CORS error is suspected (`fetch()` did reject even though `navigator.onLine` is true and origin is different), no further retries will be made.
---
+1 -1
View File
@@ -306,7 +306,7 @@ export type UrlSourceOptions = {
* failed. If the function returns `null`, no more retries will be made.
*
* By default, it uses an exponential backoff algorithm that never gives up unless
* a CORS error is suspected (`fetch()` did reject even though `navigator.onLine` is true)
* a CORS error is suspected (`fetch()` did reject, `navigator.onLine` is true and origin is different)
*/
getRetryDelay?: (previousAttempts: number, error: unknown, url: string | URL | Request) => number | null;