Class Request

Класс отвечающий за отправку curl запросов на необходимый url. Поддерживаются различные заголовки, а также возможность отправки файлов.

Hierarchy

  • Request

Constructors

constructor

Properties

attach attachName customRequest get header isAttachContent isConvertJson maxTimeQuery post url HEADER_AP_JSON HEADER_AP_XML HEADER_FORM_DATA HEADER_GZIP HEADER_RSS_XML

Methods

getError send getAttachFile

Constructors

constructor

Properties

attach

attach: null | string

Прикреплённый файл (url, путь к файлу на сервере либо содержимое файла).

attachName

attachName: string

Название параметра при отправке файла (По умолчанию file).

Default Value

file

customRequest

customRequest: null | string

Кастомный (Пользовательский) заголовок (DELETE и тд.).

get

get: null | IGetParams

Get параметры запроса.

header

header: null | HeadersInit

Отправляемые заголовки.

isAttachContent

isAttachContent: boolean

Тип передаваемого файла. True, если передается содержимое файла, иначе false. По умолчанию: false.

Default Value

false

isConvertJson

isConvertJson: boolean

Преобразовать формат ответа в json. True, если полученный ответ нужно преобразовать в json. По умолчанию true.

Default Value

true

maxTimeQuery

maxTimeQuery: null | number

Максимально время, за которое должен быть получен ответ. В мсек.

post

post: any

Post параметры запроса.

url

url: null | string

Адрес, на который отправляется запрос.

Static Readonly HEADER_AP_JSON

HEADER_AP_JSON: Record<string, string> = ...

Static Readonly HEADER_AP_XML

HEADER_AP_XML: Record<string, string> = ...

Static Readonly HEADER_FORM_DATA

HEADER_FORM_DATA: Record<string, string> = ...

Static Readonly HEADER_GZIP

HEADER_GZIP: Record<string, string> = ...

Static Readonly HEADER_RSS_XML

HEADER_RSS_XML: Record<string, string> = ...

Methods

getError

  • Возвращает текст с ошибкой, произошедшей при выполнении запроса.

    Returns

    string

    Api

    Returns null | string

send

  • Отправка запроса. Возвращаем объект. В случае успеха свойство 'status' = true.

    Returns

    Promise [

    • bool status Статус выполнения запроса.
    • mixed data Данные полученные при выполнении запроса. ]

    Api

    Type Parameters

    • T

    Parameters

    • url: null | string = null

      Адрес, на который отправляется запрос.

    Returns Promise<IRequestSend<T>>

Static getAttachFile

  • Получение содержимого файла, пригодного для отправки в запросе

    Parameters

    • filePath: string

      Расположение файла

    • Optional fileName: string

      Имя файла

    Returns null | FormData

Settings

Member Visibility

Theme

Generated using TypeDoc