Class: QueueJobFailedException

Thrown by Queue.request, Queue.result and job.result() when the message failed: its last attempt threw (it went to the dead letter queue). Its message is the one of the error, its error the error as kept. Its errno is 'E_QUEUE_JOB_FAILED'.

Example

import {type Queue, QueueJobFailedException} from '@lakutata/queue'

declare const queue: Queue
try {
    await queue.request('image.extract', {id: 7})
} catch (error) {
    if (error instanceof QueueJobFailedException) console.log(error.error.name, error.attempts)
}

Extends

• Exception

Constructors

Constructor

new QueueJobFailedException(details): QueueJobFailedException

Parameters

details

The message, its group, the attempts made and the last error.

attempts

number

error

QueueJobError

group

string

jobId

string

queue

string

Returns

QueueJobFailedException

Overrides

Exception.constructor

Properties

appId

readonly appId: string

The ID of the application the exception was created in, "Unknown" before the application's options are loaded.

Inherited from

Exception.appId

---

appName

readonly appName: string

The name of the application the exception was created in, "Unknown" before the application's options are loaded.

Inherited from

Exception.appName

---

attempts

readonly attempts: number

The attempts made.

---

cause?

optional cause?: unknown

Inherited from

Exception.cause

---

err

readonly err: string

The name of the exception's class ('OrderNotFoundException'), a copy of name kept as an own property.

Inherited from

Exception.err

---

errMsg

readonly errMsg: string

The formatted message, a copy of message kept as an own property (sent with the error by the entrypoints).

Inherited from

Exception.errMsg

---

errno

errno: string | number

'E_QUEUE_JOB_FAILED'.

Overrides

Exception.errno

---

error

readonly error: QueueJobError

The last error of the processing.

---

group

readonly group: string

The group whose processing failed.

---

jobId

readonly jobId: string

The id of the message.

---

message

message: string

Inherited from

Exception.message

---

queue

readonly queue: string

The queue of the message.

---

stack?

optional stack?: string

Inherited from

Exception.stack

---

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

Exception.stackTraceLimit

---

statusCode

readonly statusCode: number

The HTTP status the HTTP entrypoints reply with when the exception fails a request; a subclass overrides it (404 for a missing resource…).

Default

500

Inherited from

Exception.statusCode

Accessors

name

Get Signature

get name(): string

The name of the exception: the name of its class.

Returns

string

The class name.

Inherited from

Exception.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.

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:

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

Exception.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

Exception.prepareStackTrace