Class HumanReadableError

A generic error which has a friendly human readable message suitable to help a developer figure out what went wrong.

Any errors which end up being presented to developers should derive from this class.

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • new HumanReadableError(message: string, humanReadableMessage?: string, underlyingError?: Error): HumanReadableError

  • Parameters

    • message: string
    • Optional humanReadableMessage: string
    • Optional underlyingError: Error

    Returns HumanReadableError

Properties

Readonly humanReadableMessage

humanReadableMessage: string

A helpful message describing the error, suitable for displaying to developers integrating with acklo.

Optional Readonly underlyingError

underlyingError: Error

The underlying error that this error is wrapping, if any.

Generated using TypeDoc