Class BffValidationError

Hierarchy (View Summary)

BffError
- BffValidationError

Index

Accessors

Constructors

Methods

toJSON fromCode

Properties

cause? fields? meta? statusCode code

Accessors

status

get status(): number
Returns number
Inherited from BffRouteError.status

Constructors

constructor

new BffValidationError(
    code?: BffErrorCode,
    message?: string,
    fields: readonly FieldError[],
    meta?: Record<string, unknown>,
): BffValidationError
Parameters
- code: BffErrorCode = BffErrorCodes.MALFORMED_BODY
- message: string = "The request payload is invalid."
- fields: readonly FieldError[]
- Optionalmeta: Record<string, unknown>
Returns BffValidationError
Overrides BffError.constructor

Methods

toJSON

toJSON(requestId: string, timestamp?: string): ErrorResponse
Parameters
- requestId: string
- timestamp: string = ...
Returns ErrorResponse
Inherited from BffError.toJSON

`Static`fromCode

fromCode(code: BffErrorCode, options?: BffErrorOptions): BffError
Parameters
- code: BffErrorCode
- options: BffErrorOptions = {}
Returns BffError
Inherited from BffError.fromCode

Properties

`Optional` `Readonly`cause

cause?: unknown

`Optional` `Readonly`fields

fields?: readonly FieldError[]

`Optional` `Readonly`meta

meta?: Record<string, unknown>

`Readonly`statusCode

statusCode: number

`Readonly`code

code: BffErrorCode