genshin-manager
    Preparing search index...

    Class ConfigInvalidError

    Configuration invalid error

    Hierarchy (View Summary)

    Index

    Constructors

    • Constructor for ConfigInvalidError

      Parameters

      • configProperty: string

        Configuration property that is invalid

      • expectedValue: unknown

        Expected value or type

      • actualValue: unknown

        Actual invalid value

      • OptionalconfigFile: string

        Configuration file path

      • Optionalcontext: ErrorContext

        Additional error context

      • Optionalcause: Error

        Original error

      Returns ConfigInvalidError

    Properties

    category: ErrorCategory

    Error category for grouping and handling

    cause?: Error

    Original error that caused this error (Node.js 16.9.0+)

    configFile?: string

    Configuration file path if applicable

    configProperty: string

    Configuration property that is invalid

    context?: ErrorContext

    Rich context information for debugging

    errorCode: GM_CONFIG_INVALID = GenshinManagerErrorCode.GM_CONFIG_INVALID

    Unique error code for identification and classification

    isGenshinManagerError: true

    Whether this error originated from genshin-manager library

    message: string
    name: string
    retryConfig: RetryConfiguration

    Retry configuration based on error type

    stack?: string
    timestamp: Date

    Timestamp when the error occurred

    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.

    Methods

    • Serialize error for logging or transport

      Returns Record<string, unknown>

    • 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