Class: DockerRequestException

Thrown when the daemon refuses a request and no other exception of the component fits: a container name already used (HTTP 409), a container not running (HTTP 409), credentials refused by a registry (Docker.loginRepository), a network with containers connected, an image used by a container, an invalid parameter (HTTP 400), a failure of the daemon (HTTP 500). Its message is the daemon's, its statusCode the HTTP status of the daemon's answer. Its errno is E_DOCKER_REQUEST.

Extends

• Exception

Constructors

Constructor

new DockerRequestException(statusCode, message): DockerRequestException

Create the exception of a refused request: the component creates it, an application does not.

Parameters

statusCode

number

The HTTP status of the daemon's answer.

message

string

The daemon's message.

Returns

DockerRequestException

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

---

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

The error number or code identifying the error to the clients and the logs ('E_ORDER_NOT_FOUND'); each subclass sets it.

Overrides

Exception.errno

---

message

message: string

Inherited from

Exception.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 of the daemon's answer (409, 500…); the HTTP entrypoints reply with it when the exception fails a request.

Overrides

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