Перейти к основному содержимому
Version: 3.7.x

Описание API

Параметры запросов:

NameTypeComments
endpointstringURL запроса
responseSchemajoi schemaсхема ответа joi
body<YourType>тело запроса
queryParamsRecord<string,any>объект query параметров запроса
translateFunction(key,options) => stringколлбек, который будет вызван для возможного перевода поля errorText
isErrorTextStraightToOutputbooleanфлаг, выключающий преобразование текста ошибки - будет проброшен напрямую с бекенда без возможности перевода библиотекой
extraValidationCallback(response:<YourType>)=>booleanколлбек, который можно использовать для кастомной валидации ответа
customTimeoutnumberколичество миллисекунд до таймаута запроса (включая попытки повторного запроса если указан параметр retry и запрос прошёл неудачно)
retrynumberколичество попыток запрос данные еще раз если ответ не успешен
pureJsonFileResponsebooleanфлаг, убирающий доп заголовки для возможности получения файла (доступно только для PureRestRequest)

Также состоит из множества fetch параметров (headers, mode, итд), можно посмотреть тут

Получаемые поля из всех типов запросов:

NameTypeComments
errorbooleanфлаг состояния ошибки
errorTextstringтекст ошибки
data<YourType>данные ответа
additionalErrorsanyлюбые дополнительные данные с бекенда
codenumberкод состояния ошибки