umbot
    Preparing search index...

    Interface IRequestSend<T>

    Интерфейс ответа на HTTP-запрос Описывает структуру данных, возвращаемых после выполнения запроса

    // Пример использования с типом User
    interface User {
      id: number;
      name: string;
    }

    const response: IRequestSend<User> = {
      status: true,
      data: { id: 1, name: "John" }
    };

    // Пример обработки ошибки
    const errorResponse: IRequestSend<User> = {
      status: false,
      data: null,
      err: "User not found"
    };
    interface IRequestSend<T> {
        data: T | null;
        err?: string | Error;
        errorBody?: string;
        httpStatus?: number;
        status: boolean;
    }

    Type Parameters

    • T

      Тип данных, ожидаемых в ответе от сервера

    Index

    Properties

    data err? errorBody? httpStatus? status

    Properties

    data: T | null

    Данные, полученные от сервера

    • null - в случае ошибки или отсутствия данных
    • T - данные в формате, указанном в типе
    err?: string | Error

    Ошибка (объект Error либо текст ошибки). Присутствует только в случае неуспешного выполнения запроса (status = false)

    errorBody?: string

    Тело ответа сервера со статусом не 2xx (обрезается до 1000 символов). Платформы кладут туда причину отказа и параметры повтора (retry_after у Telegram).

    httpStatus?: number

    HTTP-статус ответа, если сервер ответил не 2xx. Отсутствует, если ответа не было (таймаут, сетевая ошибка). Нужен, чтобы отличать, например, 429 от 400.

    status: boolean

    Статус выполнения запроса

    • true - запрос выполнен успешно
    • false - произошла ошибка при выполнении запроса

    Settings

    Member Visibility

    On This Page

    Properties