vattenfall-europe-sales-api
    Preparing search index...

    Class VattenfallServiceError

    Class representing an error from the Vattenfall service. Extends the native Error class and adds additional properties and methods to handle specific error scenarios related to the Vattenfall service.

    Hierarchy

    • Error
      • VattenfallServiceError
    Index

    Holds the ErrorReport returned by the server.

    message: string
    name: string
    stack?: string
    status_code?: StatusCode

    Represents the StatusCode provided by the server.

    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    • get error_code(): string | undefined

      Retrieves the error code associated with the current instance.

      Returns string | undefined

      The error code if available, otherwise undefined.

    • get technical_description(): string | undefined

      Retrieves the technical description from the data object, if available.

      Returns string | undefined

      The technical description or undefined if it is not present.

    • get user_description(): string | undefined

      Retrieves the user description.

      Returns string | undefined

      The user description if available, otherwise undefined.

    • Checks if the error code indicates that the terms of use have not been accepted.

      Returns boolean

      True if the error code is "ERROR_NUTZUNGSBEDINGUNGEN_BESTAETIGUNG_ERFORDERLICH", otherwise false.

    • Checks if the current error instance is due to a token expiration.

      This method verifies if the error is associated with an access denial caused by an expired token. It does this by checking if the status_code is "ACCESS_DENIED" and if the Code attribute within the data object is "ERROR_TOKEN_EXPIRED".

      Returns boolean

      True if the error is due to an expired token, false otherwise.

    • Checks if the current error status code indicates a user error.

      Returns boolean

      True if the status code is "USER_ERROR", otherwise false.

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack; // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
      b();
      }

      function b() {
      c();
      }

      function c() {
      // Create an error without stack trace to avoid calculating the stack trace twice.
      const { stackTraceLimit } = Error;
      Error.stackTraceLimit = 0;
      const error = new Error();
      Error.stackTraceLimit = stackTraceLimit;

      // Capture the stack trace above function b
      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
      throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any