True Myth

Appearance

True Myth / task / RetryFailed

Class: RetryFailed<E> ​

An Error subclass for when a Task rejected after a specified number of retries. It includes all rejection reasons, including the final one, as well as the number of retries and the total duration spent on the retries. It distinguishes between the list of rejections and the optional cause property inherited from Error so that it can indicate if the retries failed because the retry strategy was exhausted (in which case cause will be undefined) or because the caller returned a StopRetrying instance (in which case cause will be that instance.)

You can neither construct nor subclass this error, only use its properties. If you need to check whether an Error class is an instance of this class, you can check whether its name is RETRY_FAILED_NAME or you can use the isRetryFailed helper function:

ts
import * as task from 'true-myth/task';

// snip
let result = await someFnThatReturnsATask();
if (result.isErr) {
  if (task.isRetryFailed(result.error)) {
    if (result.error.cause) {
      console.error('You quit on purpose: ', cause);
    }

    for (let rejection of result.error.rejections) {
      console.error(rejection);
     }
  } else {
    // handle other error types
  }
}

Extends ​

  • Error

Type Parameters ​

E ​

E

Properties ​

cause? ​

optional cause: unknown

Inherited from ​

Error.cause

message ​

message: string

Inherited from ​

Error.message

rejections ​

readonly rejections: E[]

Set of all rejections collected during retries.

stack? ​

optional stack: string

Inherited from ​

Error.stack

totalDuration ​

readonly totalDuration: number

Elapsed time in milliseconds.

tries ​

readonly tries: number

Number of retries before the task failed.

stackTraceLimit ​

static stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from ​

Error.stackTraceLimit

Accessors ​

name ​

Get Signature ​

get name(): "TrueMyth.Task.RetryFailed"

Returns ​

"TrueMyth.Task.RetryFailed"

Overrides ​

Error.name

Methods ​

captureStackTrace() ​

static captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters ​

targetObject ​

object

constructorOpt? ​

Function

Returns ​

void

Inherited from ​

Error.captureStackTrace

prepareStackTrace() ​

static prepareStackTrace(err, stackTraces): any

Parameters ​

err ​

Error

stackTraces ​

CallSite[]

Returns ​

any

See ​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from ​

Error.prepareStackTrace