Skip to content

Class: NotFoundError

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

Stable

404 — no such thing, or no permission to know it exists.

Confluence returns 404 for both, deliberately: telling the two apart would leak the existence of restricted content.

Extends

Constructors

Constructor

ts
new NotFoundError(
   message, 
   statusText, 
   body, 
   options?): NotFoundError;

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

Parameters

ParameterType
messagestring
statusTextstring
bodyunknown
options?ApiErrorOptions

Returns

NotFoundError

Overrides

ApiError.constructor

Properties

[ERROR_KINDS]

ts
readonly [ERROR_KINDS]: readonly ErrorKind[];

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

Overrides

ApiError.[ERROR_KINDS]


body

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

Inherited from

ApiError.body


cause?

ts
optional cause?: unknown;

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

Inherited from

ApiError.cause


message

ts
message: string;

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

Inherited from

ApiError.message


name

ts
name: string;

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

Inherited from

ApiError.name


stack?

ts
optional stack?: string;

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

Inherited from

ApiError.stack


status

ts
readonly status: number;

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

HTTP status.

Inherited from

ApiError.status


statusText

ts
readonly statusText: string;

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

Inherited from

ApiError.statusText


stackTraceLimit

ts
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

ApiError.stackTraceLimit

Methods

[hasInstance]()

ts
static hasInstance: boolean;

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

Parameters

ParameterType
valueunknown

Returns

boolean

Overrides

ApiError.[hasInstance]


captureStackTrace()

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

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

ParameterType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

ApiError.captureStackTrace


prepareStackTrace()

ts
static prepareStackTrace(err, stackTraces): any;

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

Parameters

ParameterType
errError
stackTracesCallSite[]

Returns

any

See

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

Inherited from

ApiError.prepareStackTrace