Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HubError

Represents an error returned by an Identity Hub.

Hierarchy

  • Error
    • HubError

Index

Constructors

Properties

Methods

Constructors

constructor

  • new HubError(body: IHubError): HubError

Properties

Private __hubError

__hubError: boolean = true

Private body

body: IHubError

message

message: string

name

name: string

Optional stack

stack: undefined | string

Static Error

Error: ErrorConstructor

Methods

getErrorCode

  • getErrorCode(): HubErrorCode

  • Returns the error code given by the Hub.

    Returns HubErrorCode

getRawError

  • getRawError(): IHubError

  • Returns the raw error JSON as provided by the Hub.

    Returns IHubError

getTarget

  • getTarget(): undefined | string

  • Returns the error target (e.g. the property which is invalid).

    Returns undefined | string

Static is

  • is(err: any): boolean

  • Indicates whether the passed-in object is a HubError instance.

    Parameters

    • err: any

    Returns boolean

Generated using TypeDoc