Skip to main content

ForbiddenError

@quik/http


@quik/http / ForbiddenError

Class: ForbiddenError

Defined in: http/src/errors/ForbiddenError.ts:6

Error thrown when an endpoint has restricted access.

Extends

  • QTranslatableError

Constructors

Constructor

new ForbiddenError(message?): ForbiddenError

Defined in: http/src/errors/ForbiddenError.ts:12

Constructor of the ForbiddenError.

Parameters

message?

string

The message to be returned.

Returns

ForbiddenError

Overrides

QTranslatableError.constructor

Properties

code

code: number

Defined in: core/src/errors/QError.ts:8

The code of the error.

Inherited from

QTranslatableError.code


parameters

parameters: Record<string, any> = {}

Defined in: core/src/errors/QError.ts:12

The additional features sent to the exception.

Inherited from

QTranslatableError.parameters

Accessors

translated

Get Signature

get translated(): string

Defined in: core/src/errors/QTranslatableError.ts:12

Returns

string

Inherited from

QTranslatableError.translated

Methods

toObject()

toObject(): object

Defined in: core/src/errors/QError.ts:45

Returns

object

code

code: number

message

message: string

parameters

parameters: Record<string, any>

stack

stack: string

translated

translated: string

Inherited from

QTranslatableError.toObject


withContext()

withContext(context): this

Defined in: core/src/errors/QError.ts:26

Attach context metadata to the error parameters.

Parameters

context

Record<string, unknown>

Context data to attach.

Returns

this

Inherited from

QTranslatableError.withContext