telegramsjs
    Preparing search index...

    Class HTTPResponseError

    Represents an HTTP response error received from Telegram API. Extends the base TelegramError class to include specific details about the error response.

    Hierarchy

    • Error
      • HTTPResponseError
    Index

    Constructors

    Properties

    code: string | number
    description: string
    message: string
    name: string
    parameters: { migrate_to_chat_id?: number; retry_after?: number } | undefined
    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.

    Accessors

    • get headers(): Headers | null

      The headers of the HTTP response.

      Returns Headers | null

      The response headers, or null if not available.

    • get status(): number | null

      The HTTP status code of the response.

      Returns number | null

      The HTTP status code, or null if not available.

    • get statusText(): string | null

      The status text of the HTTP response.

      Returns string | null

      The status text, or null if not available.

    • get url(): string | null

      The URL of the request that caused the error.

      Returns string | null

      The URL of the request, or null if not available.

    Methods

    • 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