Class ForbiddenHttpError

An error thrown when an agent is not allowed to access data.

Hierarchy

BaseHttpError
- ForbiddenHttpError

Index

Constructors

Properties

cause? errorCode message metadata name stack? statusCode isInstance statusCode uri

Methods

generateMetadata

Constructors

constructor

new ForbiddenHttpError(message?, options?): ForbiddenHttpError
Parameters
- Optionalmessage: string
- Optionaloptions: HttpErrorOptions
Returns ForbiddenHttpError
Overrides BaseHttpError.constructor
- Defined in src/util/errors/ForbiddenHttpError.ts:11

Properties

`Optional` `Readonly`cause

cause?: unknown

`Readonly`errorCode

errorCode: string

message

message: string

`Readonly`metadata

metadata: RepresentationMetadata

name

name: string

`Optional`stack

stack?: string

`Readonly`statusCode

statusCode: 403

`Static` `Readonly`isInstance

isInstance: ((error: unknown) => error is HttpError<403>)

Checks whether the given error is an instance of this class.

`Static` `Readonly`statusCode

statusCode: 403

The status code corresponding to this error class.

`Static` `Readonly`uri

uri: NamedNode<string>

A unique URI identifying this error class.

Methods

`Protected`generateMetadata

generateMetadata(): void
Initializes the error metadata.

Returns void
Inherited from BaseHttpError.generateMetadata
- Defined in src/util/errors/HttpError.ts:57