ForgeApiError

Defined in: packages/core/src/errors/ForgeApiError.ts:25

Base class for all HTTP errors thrown by @forge-clients API calls. Subclasses are thrown for specific HTTP status codes.

Example

import { NotFoundError, ForbiddenError } from '@forge-clients/core';

try {
  const issue = await getIssue(client, { path: { issueIdOrKey: 'PROJ-1' } });
} catch (err) {
  if (err instanceof NotFoundError) {
    console.log('Issue not found');
  } else if (err instanceof ForbiddenError) {
    console.log('No permission to view this issue');
  }
}

Extends

Error

Extended by

Constructors

Constructor

new ForgeApiError(status, body, path): ForgeApiError

Defined in: packages/core/src/errors/ForgeApiError.ts:31

Parameters

status

number

The HTTP status code returned by the API

body

unknown

The parsed JSON response body (or {} if parsing failed)

path

string

The API path that was requested

Returns

ForgeApiError

Overrides

Error.constructor

Properties

body

readonly body: unknown

Defined in: packages/core/src/errors/ForgeApiError.ts:35

The parsed JSON response body

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

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

Inherited from

Error.name

path

readonly path: string

Defined in: packages/core/src/errors/ForgeApiError.ts:37

The API path that returned this error

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

status

readonly status: number

Defined in: packages/core/src/errors/ForgeApiError.ts:33

The HTTP status code returned by the API

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.6.0/node_modules/@types/node/globals.d.ts:67

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

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.6.0/node_modules/@types/node/globals.d.ts:51

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

Error.captureStackTrace

fromResponse()

static fromResponse(response, path): Promise<ForgeApiError>

Defined in: packages/core/src/errors/ForgeApiError.ts:52

Parse an error Response and return the appropriate typed subclass. Used internally by generated client functions after receiving a non-2xx response.

Parameters

response

Response

The non-2xx Response from the API

path

string

The API path that was requested (for error messages)

Returns

Promise<ForgeApiError>

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@25.6.0/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace