Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OneBlinkAppsError

An error class that extends Error

Hierarchy

  • Error
    • OneBlinkAppsError

Index

Constructors

  • new OneBlinkAppsError(message: string, options?: { httpStatusCode?: number; isOffline?: boolean; originalError?: Error; requiresAccessRequest?: boolean; requiresLogin?: boolean; title?: string }): OneBlinkAppsError
  • Used to create an instance of the OneBlinkAppsError class.

    Parameters

    • message: string

      The message associated with the error

    • options: { httpStatusCode?: number; isOffline?: boolean; originalError?: Error; requiresAccessRequest?: boolean; requiresLogin?: boolean; title?: string } = {}

      The options associated with the error

      • Optional httpStatusCode?: number

        The http status code associated with the error

      • Optional isOffline?: boolean

        Whether the application state is offline

      • Optional originalError?: Error

        The original error that was thrown

      • Optional requiresAccessRequest?: boolean

        Whether the attempted action required access

      • Optional requiresLogin?: boolean

        Whether the attempted action required login

      • Optional title?: string

        The title of the error

    Returns OneBlinkAppsError

Properties

httpStatusCode?: number

The http status code associated with the error

isOffline: boolean

Whether the application state is offline

message: string
name: string
originalError?: Error

The original error that was thrown

requiresAccessRequest: boolean

Whether the attempted action required access

requiresLogin: boolean

Whether the attempted action required login

stack?: string
title?: string

The title of the error

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

Type declaration

stackTraceLimit: number

Methods

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void
  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void