Class: UnauthorizedException

Defined in: packages/core/src/exceptions/unauthorized.exception.ts:6

Exception for 401 Unauthorized errors

Extends

• HttpException

Constructors

Constructor

new UnauthorizedException(message?, details?): UnauthorizedException;

Defined in: packages/core/src/exceptions/unauthorized.exception.ts:13

Create a new UnauthorizedException

Parameters

Parameter	Type	Default value	Description
message	string | Record<string, unknown>	"Unauthorized"	Error message
details?	Record<string, any>	undefined	Additional error details

Returns

UnauthorizedException

Overrides

HttpException.constructor

Methods

getResponse()

getResponse(): string | Record<string, unknown>;

Defined in: packages/core/src/exceptions/http-exception.ts:17

Get the exception response

Returns

string | Record<string, unknown>

Inherited from

HttpException.getResponse

---

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: 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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

HttpException.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/bun-types/globals.d.ts:1062

Create .stack property on a target object

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

HttpException.captureStackTrace

---

isError()

Call Signature

static isError(error): error is Error;

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

Parameter	Type
error	unknown

Returns

error is Error

Inherited from

HttpException.isError

Call Signature

static isError(value): value is Error;

Defined in: node_modules/bun-types/globals.d.ts:1057

Check if a value is an instance of Error

Parameters

Parameter	Type	Description
value	unknown	The value to check

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

HttpException.isError

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

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

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

HttpException.prepareStackTrace

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
cause?	public	unknown	The cause of the error.	HttpException.cause	node_modules/typescript/lib/lib.es2022.error.d.ts:24
details?	readonly	Record<string, unknown>	-	HttpException.details	packages/core/src/exceptions/http-exception.ts:8
message	public	string	-	HttpException.message	node_modules/typescript/lib/lib.es5.d.ts:1075
name	public	string	-	HttpException.name	node_modules/typescript/lib/lib.es5.d.ts:1074
stack?	public	string	-	HttpException.stack	node_modules/typescript/lib/lib.es5.d.ts:1076
statusCode	readonly	number	-	HttpException.statusCode	packages/core/src/exceptions/http-exception.ts:7
stackTraceLimit	static	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.	HttpException.stackTraceLimit	node_modules/@types/node/globals.d.ts:67