RuntimeException | @adonisjs/generic-exceptions

Runtime exceptions are raised when expectations to execute an operation are not met.

Hierarchy

RuntimeException
- RuntimeException

Index

Constructors

constructor

Properties

Accessors

errorsDoc

Methods

Constructors

constructor

new RuntimeException(message: string, status?: undefined | number, code?: undefined | string, link?: undefined | string): RuntimeException

Inherited from BaseException.__constructor
- Defined in node_modules/node-exceptions/build/src/BaseException/index.d.ts:7
Parameters
- message: string
- Optional status: undefined | number
- Optional code: undefined | string
- Optional link: undefined | string
Returns RuntimeException

Properties

message

message: string

name

name: string

Optional stack

stack: undefined | string

Accessors

Static errorsDoc

errorsDoc:

Methods

Static incompleteConfig

incompleteConfig(missingKeys: string[], file: string, forKey?: undefined | string): RuntimeException

- Defined in src/RuntimeException.ts:52
Certain keys are missing inside the config

Parameters
- missingKeys: string[]
- file: string
- Optional forKey: undefined | string
Returns RuntimeException

Static invoke

invoke(message: any, status?: number, code?: string): RuntimeException

- Defined in src/RuntimeException.ts:61
Raise custom runtime error

Parameters
- message: any
- Default value status: number = 500
- Default value code: string = "E_RUNTIME_ERROR"
Returns RuntimeException

Static missingAppKey

missingAppKey(provider: string): RuntimeException

- Defined in src/RuntimeException.ts:36
The value of appKey is missing inside the config/app.js file

Parameters
- provider: string
Returns RuntimeException

Static missingConfig

missingConfig(key: string, configLocation: string): RuntimeException

- Defined in src/RuntimeException.ts:28
The value is missing inside the config file

Parameters
- key: string
- configLocation: string
Returns RuntimeException

Static missingEnvKey

missingEnvKey(key: any): RuntimeException

- Defined in src/RuntimeException.ts:44
The value is missing inside the environment variables

Parameters
- key: any
Returns RuntimeException

Generated using TypeDoc