tasks | @pagopa/ts-commons

Index

Type aliases

Variables

Functions

Type aliases

MaxRetries

MaxRetries: "max-retries"

A RetriableTask failed too many times.

RetriableTask

RetriableTask<E, T>: E extends TransientError ? never : TaskEither<E | TransientError, T>

A Task that can be retried when it fails with a transient error

Type parameters

E
T

RetryAborted

RetryAborted: "retry-aborted"

A RetriableTask has been aborted.

TransientError

TransientError: "transient"

In the context of a retriable task, when it returns a TransientError the task can be executed again.

Variables

MaxRetries

MaxRetries: "max-retries"

RetryAborted

RetryAborted: "retry-aborted"

TransientError

TransientError: "transient"

Functions

Const delayTask

delayTask<A>(n: Millisecond, a: A): Task<A>

- Defined in src/tasks.ts:9
Returns a Task that resolves to a value after a delay.

Type parameters
- A
Parameters
- n: Millisecond
- a: A
Returns Task<A>

withRetries

withRetries<E, T>(maxRetries: number, backoff: (count: number) => Millisecond): (_: RetriableTask<E, T>, shouldAbort?: Promise<boolean>) => TaskEither<E | MaxRetries | RetryAborted, T>

- Defined in src/tasks.ts:46
Wraps a RetriableTask with a number of retries

Type parameters
- E
- T
Parameters
- maxRetries: number
- backoff: (count: number) => Millisecond
  - - (count: number): Millisecond
    - Parameters
      - count: number
      Returns Millisecond
Returns (_: RetriableTask<E, T>, shouldAbort?: Promise<boolean>) => TaskEither<E | MaxRetries | RetryAborted, T>
- - (_: RetriableTask<E, T>, shouldAbort?: Promise<boolean>): TaskEither<E | MaxRetries | RetryAborted, T>
  - Parameters
    - _: RetriableTask<E, T>
    - Optional shouldAbort: Promise<boolean>
    Returns TaskEither<E | MaxRetries | RetryAborted, T>

Generated using TypeDoc