Minima.js

Appearance

Minima.js API

Minima.js API / @minimajs/auth / ForbiddenError

Class: ForbiddenError<R> ​

Represents the response body of an HTTP error. Can be either a simple string message or a dictionary object with custom error data.

Extends ​

Type Parameters ​

R ​

R

Constructors ​

Constructor ​

ts
new ForbiddenError<R>(response, options?): ForbiddenError<R>;

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

Parameters ​

response ​

R = ...

options? ​

HttpErrorOptions

Returns ​

ForbiddenError<R>

Overrides ​

HttpError.constructor

Properties ​

base? ​

ts
optional base: unknown;

Inherited from ​

HttpError.base

cause? ​

ts
optional cause: unknown;

The cause of the error.

Inherited from ​

HttpError.cause

code? ​

ts
optional code: string;

Inherited from ​

HttpError.code

constructor ​

ts
constructor: typeof HttpError;

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

Inherited from ​

ts
HttpError.constructor

headers? ​

ts
optional headers: HeadersInit;

Inherited from ​

HttpError.headers

message ​

ts
message: string;

Inherited from ​

HttpError.message

name ​

ts
name: string;

Inherited from ​

HttpError.name

response ​

ts
response: R;

Inherited from ​

HttpError.response

stack? ​

ts
optional stack: string;

Inherited from ​

HttpError.stack

status ​

ts
status: number;

Inherited from ​

HttpError.status

stackTraceLimit ​

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

HttpError.stackTraceLimit

toJSON() ​

ts
static toJSON: <T>(err) => unknown;

Type Parameters ​

T ​

T extends HttpError<unknown> = HttpError<unknown>

Parameters ​

err ​

T

Returns ​

unknown

Inherited from ​

HttpError.toJSON

Methods ​

render() ​

ts
render(ctx): Promise<Response>;

Parameters ​

ctx ​

Context

Returns ​

Promise<Response>

Inherited from ​

HttpError.render

toJSON() ​

ts
toJSON(): unknown;

Returns ​

unknown

Inherited from ​

HttpError.toJSON

captureStackTrace() ​

Call Signature ​

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

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 ​
targetObject ​

object

constructorOpt? ​

Function

Returns ​

void

Inherited from ​

HttpError.captureStackTrace

Call Signature ​

ts
static captureStackTrace(targetObject, constructorOpt?): void;

Create .stack property on a target object

Parameters ​
targetObject ​

object

constructorOpt? ​

Function

Returns ​

void

Inherited from ​

HttpError.captureStackTrace

create() ​

ts
static create(err, status?): HttpError<string>;

Parameters ​

err ​

unknown

status? ​

number

Returns ​

HttpError<string>

Inherited from ​

HttpError.create

is() ​

ts
static is(value): value is HttpError<unknown>;

Parameters ​

value ​

unknown

Returns ​

value is HttpError<unknown>

Inherited from ​

HttpError.is

isError() ​

Call Signature ​

ts
static isError(error): error is Error;

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

Parameters ​
error ​

unknown

Returns ​

error is Error

Inherited from ​

HttpError.isError

Call Signature ​

ts
static isError(value): value is Error;

Check if a value is an instance of Error

Parameters ​
value ​

unknown

The value to check

Returns ​

value is Error

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

Inherited from ​

HttpError.isError

prepareStackTrace() ​

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

HttpError.prepareStackTrace