Class MiddlewareError

Hierarchy

Error
- MiddlewareError

Index

Constructors

Properties

_status cause? code data error message name stack? status prepareStackTrace? stackTraceLimit

Methods

captureStackTrace new withMessage

Constructors

constructor

new MiddlewareError(error: MiddlewareErrorBody<"MIDDLEWARE:INVALID_ACTION_AUTHORIZATION" | "MIDDLEWARE:UNAUTHORIZED_ACTION" | "MIDDLEWARE:MISMATCHING_AUTHORIZATION_CREDENTIALS" | "MIDDLEWARE:MISSING_AUTHORIZATION_TOKEN" | "INVALID_AUTH_TOKEN" | "NO_AUTH_TOKEN_ERROR">, status?: fail): MiddlewareError
Parameters
- error: MiddlewareErrorBody<"MIDDLEWARE:INVALID_ACTION_AUTHORIZATION" | "MIDDLEWARE:UNAUTHORIZED_ACTION" | "MIDDLEWARE:MISMATCHING_AUTHORIZATION_CREDENTIALS" | "MIDDLEWARE:MISSING_AUTHORIZATION_TOKEN" | "INVALID_AUTH_TOKEN" | "NO_AUTH_TOKEN_ERROR">
- status: fail = MiddlewareResponseStatus.fail
Returns MiddlewareError
Overrides Error.constructor
- Defined in packages/approval/src/errors.ts:91

Properties

_status

_status: fail

`Optional` cause

cause?: unknown

code

code: number

data

data: null = null

error

error: string

message

message: string

name

name: string

`Optional` stack

stack?: string

status

status: number

`Static` `Optional` prepareStackTrace

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

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

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

`Static` new

new(errorCode: "MIDDLEWARE:INVALID_ACTION_AUTHORIZATION" | "MIDDLEWARE:UNAUTHORIZED_ACTION" | "MIDDLEWARE:MISMATCHING_AUTHORIZATION_CREDENTIALS" | "MIDDLEWARE:MISSING_AUTHORIZATION_TOKEN" | "INVALID_AUTH_TOKEN" | "NO_AUTH_TOKEN_ERROR", message?: string | ((body?: unknown) => string)): MiddlewareError
Parameters
- errorCode: "MIDDLEWARE:INVALID_ACTION_AUTHORIZATION" | "MIDDLEWARE:UNAUTHORIZED_ACTION" | "MIDDLEWARE:MISMATCHING_AUTHORIZATION_CREDENTIALS" | "MIDDLEWARE:MISSING_AUTHORIZATION_TOKEN" | "INVALID_AUTH_TOKEN" | "NO_AUTH_TOKEN_ERROR"
- Optional message: string | ((body?: unknown) => string)
Returns MiddlewareError
- Defined in packages/approval/src/errors.ts:67

`Static` `Private` withMessage

withMessage(error: MiddlewareError, _message: string | ((body?: unknown) => string)): MiddlewareError
Parameters
- error: MiddlewareError
- _message: string | ((body?: unknown) => string)
Returns MiddlewareError
- Defined in packages/approval/src/errors.ts:77

Generated using TypeDoc