Class: ApiError

Defined in: src/core/errors/apiError.ts:16

Thrown when the API returns a non-2xx HTTP response.

The subclasses below cover the statuses worth branching on. Catch this one to catch them all, or a subclass — or use the predicates, which survive a duplicated install of this package.

Extends

• Error

Extended by

• AuthError
• ForbiddenError
• NotFoundError
• RateLimitError
• ServerError

Constructors

Constructor

new ApiError(
   message, 
   status, 
   statusText, 
   body, 
   options?
): ApiError;

Defined in: src/core/errors/apiError.ts:25

Parameters

Parameter	Type
message	string
status	number
statusText	string
body	unknown
options?	ApiErrorOptions

Returns

ApiError

Overrides

Error.constructor

Properties

[ERROR_KINDS]

readonly [ERROR_KINDS]: readonly ErrorKind[];

Defined in: src/core/errors/apiError.ts:17

---

body

readonly body: unknown;

Defined in: src/core/errors/apiError.ts:23

Atlassian's error payload, parsed when it was JSON and the raw text when it was not.

---

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

---

message

message: string;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

---

name

name: string;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

---

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

---

status

readonly status: number;

Defined in: src/core/errors/apiError.ts:20

HTTP status.

---

statusText

readonly statusText: string;

Defined in: src/core/errors/apiError.ts:21

---

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@types+node@22.20.1/node_modules/@types/node/globals.d.ts:68

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

Methods

[hasInstance]()

static hasInstance: boolean;

Defined in: src/core/errors/apiError.ts:34

Parameters

Parameter	Type
value	unknown

Returns

boolean

---

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@22.20.1/node_modules/@types/node/globals.d.ts:52

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@22.20.1/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace