telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Class TelegramApiError

    Hierarchy

    • Error
      • TelegramApiError
    Index
    • Constructs a new TelegramApiError.

      Parameters

      • error_code: number

        The numeric error code from the Telegram response.

      • description: string

        The error description string.

      • Optionalparameters: { migrate_to_chat_id?: number; retry_after?: number }

        Optional extra parameter payload from Telegram.

      Returns TelegramApiError

    cause?: unknown
    description: string

    Human-readable description of the error returned by Telegram.

    error_code: number

    Telegram Bot API numeric error code (e.g. 400, 401, 403, 429).

    message: string
    name: string
    parameters?: { migrate_to_chat_id?: number; retry_after?: number }

    Optional extra response parameters returned by Telegram (e.g. rate limit retry or chat migration info).

    Type Declaration

    • Optionalmigrate_to_chat_id?: number

      The group has been migrated to a supergroup with this identifier.

    • Optionalretry_after?: number

      Number of seconds to wait before repeating the request.

    stack?: string
    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.

    • 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