Skip to content

@gettoor/core v0.1.0


@gettoor/core / NotFoundToorError

Class: NotFoundToorError

Thrown when a resource is not found.

Extends

Extended by

Constructors

Constructor

new NotFoundToorError(errorCode: string, message: string): NotFoundToorError

Parameters

ParameterType
errorCodestring
messagestring

Returns

NotFoundToorError

Overrides

ToorError.constructor

Properties

cause?

optional cause?: unknown

Inherited from

ToorError.cause


message

message: string

Inherited from

ToorError.message


name

name: string

Inherited from

ToorError.name


stack?

optional stack?: string

Inherited from

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

ToorError.stackTraceLimit

Methods

getErrorCode()

getErrorCode(): string

Returns

string

Inherited from

ToorError.getErrorCode


getHttpStatusCode()

getHttpStatusCode(): number

Returns

number

Inherited from

ToorError.getHttpStatusCode


captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): 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.

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

ToorError.captureStackTrace


prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Parameters

ParameterType
errError
stackTracesCallSite[]

Returns

any

See

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

Inherited from

ToorError.prepareStackTrace


quote()

static quote(value: string): string

Parameters

ParameterType
valuestring

Returns

string

Inherited from

ToorError.quote