Built and signed on GitHub ActionsBuilt and signed on GitHub Actions
Retry and backoff decorator transport for Upyo email library
Classes
Transport decorator that retries transient delivery failures.
- config: ResolvedRetryConfig<TProviderId>
Resolved retry configuration.
- id: TProviderIdNo documentation available
- send(): Promise<Receipt<TProviderId>>message: Message,options?: TransportOptions
Sends one message, retrying retryable failures.
- sendMany(): AsyncIterable<Receipt<TProviderId>>messages: Iterable<Message> | AsyncIterable<Message>,options?: TransportOptions
Sends messages with per-message retry behavior.
Functions
Creates a retrying transport around another transport.
Interfaces
Exponential backoff settings for retry delays.
- baseDelayMilliseconds: number
Delay before the first retry, in milliseconds.
- factor: number
Multiplier applied after each failed attempt.
- maxDelayMilliseconds: number
Maximum computed delay, in milliseconds.
Context passed to custom retry wait functions.
- attempt: number
Attempt that just failed.
- delayMilliseconds: number
Delay to wait before retrying, in milliseconds.
- error: unknown
Thrown error that caused the retry, when the transport rejected.
- maxAttempts: number
Maximum configured attempts.
- nextAttempt: number
Attempt that will run after this delay.
- reason: "retry" | "sendMany-throttle"
Why the delay is being applied.
- receipt: Receipt<TProviderId> & { readonly successful: false; }
Failed receipt that caused the retry, when the transport returned one.
Configuration for the retry transport decorator.
- backoff: BackoffConfig
Exponential backoff settings.
- jitter: JitterConfig
Jitter mode applied to computed backoff delays.
- maxAttempts: number
Total number of send attempts, including the first one.
- random: () => number
Random number source for jitter.
- sendMany: SendManyRetryConfig
Retry and throttling behavior for
sendMany(). - shouldRetry: RetryClassifier<TProviderId>
Custom retry classifier.
- wait: WaitFunction<TProviderId>
Custom wait function for tests or host-controlled scheduling.
Retry behavior for sendMany().
- intervalMilliseconds: number
Minimum delay between launching message sends, in milliseconds.
- maxConcurrent: number
Maximum number of messages to send at the same time.
Type Aliases
Jitter mode for computed retry delays.
Function that decides whether a failure should be retried.
| { readonly kind: "error"; readonly error: unknown; readonly receiptError?: ReceiptError<TProviderId>; }
Failure passed to a custom retry classifier.
Function used to wait between attempts or throttled sends.