Class InvalidValueError

Hierarchy (View Summary)

StormError<{ expected: any; got: any; variable: string }>
- InvalidValueError

Index

Constructors

Properties

message name stack? prepareStackTrace? stackTraceLimit

Methods

getCode getErrorResponse getExitCode getHTTPCode getLocaleCode getLocaleParameters getMessage getPrivateDetails getPublicDetails captureStackTrace

Constructors

constructor

new InvalidValueError(
    variable: string,
    expected: any,
    got: any,
): InvalidValueError
Parameters
- variable: string
- expected: any
- got: any
Returns InvalidValueError
Overrides StormError.constructor
- Defined in src/InvalidValueError.ts:26

Properties

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

getCode

getCode(): ErrorCode
Returns ErrorCode
Overrides StormError.getCode
- Defined in src/InvalidValueError.ts:39

getErrorResponse

getErrorResponse(): IErrorResponse
Returns IErrorResponse
Inherited from StormError.getErrorResponse
- Defined in src/StormError.ts:76

getExitCode

getExitCode(): ExitCode
Returns ExitCode
Inherited from StormError.getExitCode
- Defined in src/StormError.ts:97

getHTTPCode

getHTTPCode(): StatusCode
Returns StatusCode
Overrides StormError.getHTTPCode
- Defined in src/InvalidValueError.ts:43

getLocaleCode

getLocaleCode(): string
Returns string
Overrides StormError.getLocaleCode
- Defined in src/InvalidValueError.ts:47

getLocaleParameters

getLocaleParameters(): Record<string, string>
Returns Record<string, string>
Overrides StormError.getLocaleParameters
- Defined in src/InvalidValueError.ts:51

getMessage

getMessage(): string
Returns string
Overrides StormError.getMessage
- Defined in src/InvalidValueError.ts:34

getPrivateDetails

getPrivateDetails(): { expected: any; got: any; variable: string }
Private details are only logged to the server log. They are kept secret from the client.

Returns { expected: any; got: any; variable: string }
Inherited from StormError.getPrivateDetails
- Defined in src/StormError.ts:68

getPublicDetails

getPublicDetails(): IAdditionalErrorDetails
Sends details to the client.

Returns IAdditionalErrorDetails
Inherited from StormError.getPublicDetails
- Defined in src/StormError.ts:60

`Static`captureStackTrace

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