@tgsnake/skema
    Preparing search index...

    Class AuthKeyMissing

    AuthKeyMissing

    Error thrown when the authentication key is unavailable.

    Hierarchy

    • BaseError
      • AuthKeyMissing
    Index

    Constructors

    Properties

    cause?: unknown

    The cause of the error.

    description: string = 'Auth key is unavailable, this can happen because at when the client is run, the user does not provide information to login.'
    message: string = 'Auth key unavailable'
    name: string
    stack?: string
    stackTraceLimit: number

    The maximum number of stack frames to capture.

    Methods

    • Returns { [key: string]: unknown }

    • Returns a string representation of an object.

      Returns string

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • 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

    • Check if a value is an instance of Error

      Parameters

      • value: unknown

        The value to check

      Returns value is Error

      True if the value is an instance of Error, false otherwise