Skip to main content

Class: SecurityError

Base error type emitted by the security pipeline.

This package deliberately does not depend on an HTTP response model. Transport adapters or application error filters should translate this error into a protocol-specific response. status is a package category code (1 for authentication and 2 for authorization), not an HTTP status.

Extends​

  • Error

Extended by​

Constructors​

Constructor​

new SecurityError(response, status, options?): SecurityError

Parameters​

response​

string

Human-readable error message.

status​

number

Security error category code.

options?​

Optional cause and a longer description for logging or protocol-specific error mapping.

cause?​

unknown

description?​

string

Returns​

SecurityError

Overrides​

Error.constructor

Properties​

cause?​

optional cause?: unknown

Inherited from​

Error.cause

message​

message: string

Inherited from​

Error.message

name​

name: string

Inherited from​

Error.name

options?​

readonly optional options?: object

Optional cause and a longer description for logging or protocol-specific error mapping.

cause?​

optional cause?: unknown

description?​

optional description?: string

response​

readonly response: string

Human-readable error message.

stack?​

optional stack?: string

Inherited from​

Error.stack

status​

readonly status: number

Security error category code.

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​

Error.stackTraceLimit

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​

Error.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​

Error.prepareStackTrace