Class AccessDeniedError

Error thrown when the user is not authorized to access a route

Hierarchy

AuthError
- AccessDeniedError

Index

Constructors

Properties

account? route?

Methods

createForbiddenAccessError createUnauthorizedAccessError

Constructors

constructor

new AccessDeniedError(errorCode: string, errorMessage?: string, route?: string, account?: AccountInfo): AccessDeniedError
Parameters
- errorCode: string
- Optional errorMessage: string
- Optional route: string
- Optional account: AccountInfo
Returns AccessDeniedError
Overrides AuthError.constructor
- Defined in error/AccessDeniedError.ts:29

Properties

`Optional` account

account?: AccountInfo

`Optional` route

route?: string

Methods

`Static` createForbiddenAccessError

createForbiddenAccessError(route?: string, account?: AccountInfo): AccessDeniedError
Creates an error when the access is forbidden

Returns
Empty issuer error
Parameters
- Optional route: string
- Optional account: AccountInfo
Returns AccessDeniedError
- Defined in error/AccessDeniedError.ts:57

`Static` createUnauthorizedAccessError

createUnauthorizedAccessError(route?: string, account?: AccountInfo): AccessDeniedError
Creates an error when access is unauthorized

Returns
Empty issuer error
Parameters
- Optional route: string
- Optional account: AccountInfo
Returns AccessDeniedError
- Defined in error/AccessDeniedError.ts:43

Generated using TypeDoc