Class H5pError

Represents a localizable error that can be reported back to the user. The actual error text that is displayed to the user should not be passed to the error in code. Use the errorId to tell the translation service which error this is. Optionally you can also pass in a debugError. DO NOT USE THIS CLASS FOR INTERNAL ERRORS SENT TO THE DEVELOPER!

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

cause? clientErrorId? debugMessage? errorId httpStatusCode message name replacements stack? prepareStackTrace? stackTraceLimit

Constructors

constructor

  • new H5pError(
        errorId: string,
        replacements?: { [key: string]: string | string[] },
        httpStatusCode?: number,
        debugMessage?: string,
        clientErrorId?: string,
    ): H5pError

    Parameters

    • errorId: string
    • replacements: { [key: string]: string | string[] } = {}
    • httpStatusCode: number = 500
    • OptionaldebugMessage: string
    • OptionalclientErrorId: string

    Returns H5pError

Properties

Optionalcause

cause?: unknown

OptionalclientErrorId

clientErrorId?: string

OptionaldebugMessage

debugMessage?: string

errorId

errorId: string

httpStatusCode

httpStatusCode: number = 500

message

message: string

name

name: string

replacements

replacements: { [key: string]: string | string[] } = {}

Optionalstack

stack?: string

Static OptionalprepareStackTrace

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

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

    Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR