EventError

Hierarchy

• Error
  • EventError

Implements

• HttpError

Index

Constructors

• constructor

Properties

• attributes
• error
• errorHandling
• expose
• forceLevel
• headers
• isEventError
• message
• original
• statusCode
• thrown
• errors
• is
• parse
• schema
• validate

Accessors

• isClientError
• isInformational
• isRedirection
• isServerError
• isSuccess
• level

Methods

• _is
• badGateway
• badRequest
• conflict
• expectationFailed
• failedDependency
• forbidden
• from
• gatewayTimeout
• gone
• internal
• internalServerError
• lengthRequired
• locked
• log
• loopDetected
• methodNotAllowed
• noResponse
• notAcceptable
• notFound
• notImplemented
• payloadTooLarge
• paymentRequired
• preconditionFailed
• preconditionRequired
• proxyAuthRequired
• rangeNotSatisfiable
• requestTimeout
• retryable
• serviceUnavailable
• teapot
• tooEarly
• tooManyRequests
• unauthorized
• unavailableForLegalReasons
• unexpectedEventType
• unprocessableEntity
• unsupportedMediaType
• uriTooLong
• validation

Constructors

publicconstructor

• new EventError(message?: ErrorLike, __namedParameters?: EventOptions): EventError

• Overrides Error.constructor

  Parameters

  • optionalmessage: ErrorLike

  • __namedParameters: EventOptions = {}

  Returns EventError

Properties

publicattributes

attributes: unknown

publicerror

error: string

publicerrorHandling

errorHandling: graceful | throw

publicexpose

expose: boolean

publicforceLevel

forceLevel: undefined | error | info | warning

publicheaders

headers: undefined | HTTPHeaders

publicisEventError

isEventError: boolean = true

publicmessage

message: string

Implementation of HttpError.message

Overrides Error.message

publicoriginal

original: unknown

publicstatusCode

statusCode: number

Implementation of HttpError.statusCode

publicthrown

thrown: boolean

publicstaticerrors

errors: undefined | ErrorObject<string, Record<string, any>, unknown>[] = HttpError.errors

publicstaticis

is: (o: unknown) => o is HttpError = HttpError.is

Type declaration

• • (o: unknown): o is HttpError

  • Parameters

    • o: unknown

    Returns o is HttpError

publicstaticparse

parse: (o: unknown) => { right: HttpError } | { left: DefinedError[] } = HttpError.parse

Type declaration

• • (o: unknown): { right: HttpError } | { left: DefinedError[] }

  • Parameters

    • o: unknown

    Returns { right: HttpError } | { left: DefinedError[] }

publicstaticschema

schema: AnySchema = HttpError.schema

publicstaticvalidate

validate: ValidateFunction<HttpError> = HttpError.validate

Accessors

publicisClientError

• get isClientError(): boolean

• Returns boolean

publicisInformational

• get isInformational(): boolean

• Returns boolean

publicisRedirection

• get isRedirection(): boolean

• Returns boolean

publicisServerError

• get isServerError(): boolean

• Returns boolean

publicisSuccess

• get isSuccess(): boolean

• Returns boolean

publiclevel

• get level(): error | info | warning

• Returns error | info | warning

Methods

publicstatic_is

• _is<O>(e: EventError | O): e is EventError

• Type parameters

  • O

  Parameters

  • e: EventError | O

  Returns e is EventError

publicstaticbadGateway

• badGateway<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticbadRequest

• badRequest<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticconflict

• conflict<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticexpectationFailed

• expectationFailed<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticfailedDependency

• failedDependency<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticforbidden

• forbidden<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticfrom

• from(error: unknown): EventError

• Parameters

  • error: unknown

  Returns EventError

publicstaticgatewayTimeout

• gatewayTimeout<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticgone

• gone<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticinternal

• internal<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticinternalServerError

• internalServerError<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticlengthRequired

• lengthRequired<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticlocked

• locked<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticlog

• log(logger: Logger, error: unknown, mode?: error | level): EventError

• Parameters

  • logger: Logger

  • error: unknown

  • mode: error | level = 'level'

  Returns EventError

publicstaticloopDetected

• loopDetected<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticmethodNotAllowed

• methodNotAllowed(options: EventOptions & { allow: HTTPMethod[]; message?: ErrorLike }): EventError

• Parameters

  • options: EventOptions & { allow: HTTPMethod[]; message?: ErrorLike }

  Returns EventError

publicstaticnoResponse

• noResponse<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticnotAcceptable

• notAcceptable<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticnotFound

• notFound<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticnotImplemented

• notImplemented<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticpayloadTooLarge

• payloadTooLarge<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticpaymentRequired

• paymentRequired<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticpreconditionFailed

• preconditionFailed<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticpreconditionRequired

• preconditionRequired<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticproxyAuthRequired

• proxyAuthRequired<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticrangeNotSatisfiable

• rangeNotSatisfiable<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticrequestTimeout

• requestTimeout<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticretryable

• retryable<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticserviceUnavailable

• serviceUnavailable<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticteapot

• teapot<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstatictooEarly

• tooEarly<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstatictooManyRequests

• tooManyRequests<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticunauthorized

• unauthorized<T>(message: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • message: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticunavailableForLegalReasons

• unavailableForLegalReasons<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticunexpectedEventType

• unexpectedEventType<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticunprocessableEntity

• unprocessableEntity<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticunsupportedMediaType

• unsupportedMediaType<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticuriTooLong

• uriTooLong<T>(message?: ErrorLike, options?: T): EventError

• Type parameters

  • T: EventOptions | ExactObject<EventOptions, T>

  Parameters

  • optionalmessage: ErrorLike

  • optionaloptions: T

  Returns EventError

publicstaticvalidation

• validation(options?: EventOptions & ({ errors?: null | ErrorObject<string, Record<string, any>, unknown>[]; location?: string } | { left?: null | ErrorObject<string, Record<string, any>, unknown>[]; location?: string })): EventError

• Parameters

  • options: EventOptions & ({ errors?: null | ErrorObject<string, Record<string, any>, unknown>[]; location?: string } | { left?: null | ErrorObject<string, Record<string, any>, unknown>[]; location?: string }) = {}

  Returns EventError