Class InvalidEnvironmentError

An exception thrown when certain operations are attempted in a DataAPIEnvironment that is not valid.

Field

currentEnvironment - The environment that was attempted to be used

Field

expectedEnvironments - The environments that are valid for the operation

Hierarchy

  • Error
    • InvalidEnvironmentError

Constructors

constructor

Properties

currentEnvironment expectedEnvironments message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new InvalidEnvironmentError(operation, currentEnvironment, expectedEnvironments, extra?): InvalidEnvironmentError
  • Internal

    Should not be instantiated by the user.

    Parameters

    • operation: string
    • currentEnvironment: string
    • expectedEnvironments: string[]
    • extra: string = ''

    Returns InvalidEnvironmentError

Properties

Readonly currentEnvironment

currentEnvironment: string

The environment that was attempted to be used.

Readonly expectedEnvironments

expectedEnvironments: string[]

The environments that are valid for the operation.

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcurrentEnvironmentexpectedEnvironmentsmessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace