umbot - v2.0.8
    Preparing search index...

    Class YandexRequest

    YandexRequest Класс для работы с API Яндекса

    Предоставляет методы для отправки запросов к API Яндекса, управления авторизацией и обработки ошибок.

    // Создание экземпляра
    const api = new YandexRequest('your-token');

    // Установка нового токена
    api.setOAuth('new-token');

    // Выполнение запроса
    const result = await api.call<ApiResponse>('https://api.yandex.ru/endpoint');
    if (result) {
      // Обработка успешного ответа
      console.log(result);
    } else {
      // Обработка ошибки
      console.error(api._error);
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    setOAuth call

    Constructors

    • Создает экземпляр класса YandexRequest

      Инициализирует класс с OAuth-токеном и настраивает параметры HTTP-запросов.

      Parameters

      • Optionaloauth: null | string = null

        OAuth-токен для авторизации

      Returns YandexRequest

      Если токен не указан, будет использован токен из mmApp.params.yandex_token. Если и там токена нет, запросы будут выполняться без авторизации.

      // Создание с токеном
      const api = new YandexRequest('your-token');

      // Создание без токена (будет использован токен из mmApp.params)
      const api = new YandexRequest();

      // Создание без авторизации
      const api = new YandexRequest(null);

    Methods

    • Устанавливает OAuth-токен для авторизации

      Обновляет токен авторизации и заголовки запросов. При установке токена автоматически добавляется заголовок 'Authorization: OAuth {token}' ко всем последующим запросам.

      Parameters

      • oauth: null | string

        OAuth-токен для авторизации

      Returns void

      • Если передать null, авторизация будет отключена
      • Заголовок авторизации добавляется автоматически
      • Токен сохраняется для всех последующих запросов
      const api = new YandexRequest();

      // Установка нового токена
      api.setOAuth('new-token');
      // Теперь все запросы будут с заголовком:
      // Authorization: OAuth new-token

      // Сброс токена
      api.setOAuth(null);
      // Запросы будут без авторизации

    • Выполняет HTTP-запрос к API Яндекса

      Отправляет запрос к указанному эндпоинту API и обрабатывает полученный ответ.

      Type Parameters

      • T extends IYandexApi

        Тип ожидаемого ответа, наследующий интерфейс IYandexApi

      Parameters

      • Optionalurl: null | string = null

        URL-адрес эндпоинта API

      Returns Promise<null | T>

      • Результат запроса или null в случае ошибки

      Если произошла ошибка сети или сервера

      interface MyApiResponse extends IYandexApi {
        data: {
          id: string;
          name: string;
        };
      }

      const api = new YandexRequest('token');

      try {
        // Выполнение запроса
        const response = await api.call<MyApiResponse>('https://api.yandex.ru/endpoint');

        if (response) {
          // Обработка успешного ответа
          console.log('ID:', response.data.id);
          console.log('Name:', response.data.name);
        } else {
          // Обработка ошибки API
          console.error('Ошибка API:', api._error);
        }
      } catch (error) {
        // Обработка ошибок сети или сервера
        console.error('Ошибка запроса:', error);
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods