Class AccessDeniedException

Represents an exception that is thrown when access to a resource is denied.

Example

throw new AccessDeniedException({
 action: 'js:core:users:get',
 context: { id: 1 }
});

Hierarchy

ForbiddenException
- AccessDeniedException

Index

Constructors

constructor

new AccessDeniedException(
__namedParameters: AccessDeniedExceptionInput,
): AccessDeniedException
Parameters
- __namedParameters: AccessDeniedExceptionInput
Returns AccessDeniedException
Overrides ForbiddenException.constructor
- Defined in src/exceptions/access-denied.exception.ts:21

Properties

cause

cause: unknown

Exception cause. Indicates the specific original cause of the error. It is used when catching and re-throwing an error with a more-specific or useful error message in order to still have access to the original error.

message

message: string

name

name: string

`Optional`stack

stack?: string

`Static` `Optional`prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

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

`Static`stackTraceLimit

stackTraceLimit: number

Methods

getResponse

getResponse(): string | object
Returns string | object
Inherited from ForbiddenException.getResponse
- Defined in node_modules/@nestjs/common/exceptions/http.exception.d.ts:72

getStatus

getStatus(): number
Returns number
Inherited from ForbiddenException.getStatus
- Defined in node_modules/@nestjs/common/exceptions/http.exception.d.ts:73

initCause

initCause(): void
Configures error chaining support

Returns void
See
- https://nodejs.org/en/blog/release/v16.9.0/#error-cause
- https://github.com/microsoft/TypeScript/issues/45167
Inherited from ForbiddenException.initCause
- Defined in node_modules/@nestjs/common/exceptions/http.exception.d.ts:69

initMessage

initMessage(): void
Returns void
Inherited from ForbiddenException.initMessage
- Defined in node_modules/@nestjs/common/exceptions/http.exception.d.ts:70

initName

initName(): void
Returns void
Inherited from ForbiddenException.initName
- Defined in node_modules/@nestjs/common/exceptions/http.exception.d.ts:71

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from ForbiddenException.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:136

`Static`createBody

createBody(
    nil: null | "",
    message: HttpExceptionBodyMessage,
    statusCode: number,
): HttpExceptionBody
Parameters
- nil: null | ""
- message: HttpExceptionBodyMessage
- statusCode: number
Returns HttpExceptionBody
Inherited from ForbiddenException.createBody
- Defined in node_modules/@nestjs/common/exceptions/http.exception.d.ts:74
createBody(
    message: HttpExceptionBodyMessage,
    error: string,
    statusCode: number,
): HttpExceptionBody
Parameters
- message: HttpExceptionBodyMessage
- error: string
- statusCode: number
Returns HttpExceptionBody
Inherited from ForbiddenException.createBody
- Defined in node_modules/@nestjs/common/exceptions/http.exception.d.ts:75
createBody<Body extends Record<string, unknown>>(custom: Body): Body
Type Parameters
- Body extends Record<string, unknown>
Parameters
- custom: Body
Returns Body
Inherited from ForbiddenException.createBody
- Defined in node_modules/@nestjs/common/exceptions/http.exception.d.ts:76

`Static`extractDescriptionAndOptionsFrom

extractDescriptionAndOptionsFrom(
descriptionOrOptions: string | HttpExceptionOptions,
): DescriptionAndOptions
Utility method used to extract the error description and httpExceptionOptions from the given argument. This is used by inheriting classes to correctly parse both options.
Parameters
- descriptionOrOptions: string | HttpExceptionOptions
Returns DescriptionAndOptions
the error description and the httpExceptionOptions as an object.
Inherited from ForbiddenException.extractDescriptionAndOptionsFrom
- Defined in node_modules/@nestjs/common/exceptions/http.exception.d.ts:84

`Static`getDescriptionFrom

getDescriptionFrom(descriptionOrOptions: string | HttpExceptionOptions): string
Parameters
- descriptionOrOptions: string | HttpExceptionOptions
Returns string
Inherited from ForbiddenException.getDescriptionFrom
- Defined in node_modules/@nestjs/common/exceptions/http.exception.d.ts:77

`Static`getHttpExceptionOptionsFrom

getHttpExceptionOptionsFrom(
descriptionOrOptions: string | HttpExceptionOptions,
): HttpExceptionOptions
Parameters
- descriptionOrOptions: string | HttpExceptionOptions
Returns HttpExceptionOptions
Inherited from ForbiddenException.getHttpExceptionOptionsFrom
- Defined in node_modules/@nestjs/common/exceptions/http.exception.d.ts:78

Class AccessDeniedException

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AccessDeniedException

Properties

cause

message

name

Optionalstack

Static OptionalprepareStackTrace

See

StaticstackTraceLimit

Methods

getResponse

Returns string | object

getStatus

Returns number

initCause

Returns void

See

initMessage

Returns void

initName

Returns void

StaticcaptureStackTrace

Parameters

Returns void

StaticcreateBody

Parameters

Returns HttpExceptionBody

Parameters

Returns HttpExceptionBody

Type Parameters

Parameters

Returns Body

StaticextractDescriptionAndOptionsFrom

Parameters

Returns DescriptionAndOptions

StaticgetDescriptionFrom

Parameters

Returns string

StaticgetHttpExceptionOptionsFrom

Parameters

Returns HttpExceptionOptions

Settings

On This Page

`Optional`stack

`Static` `Optional`prepareStackTrace

`Static`stackTraceLimit

`Static`captureStackTrace

`Static`createBody

`Static`extractDescriptionAndOptionsFrom

`Static`getDescriptionFrom

`Static`getHttpExceptionOptionsFrom