HttpApiRequest

Hierarchy

  • HttpApiRequest

Properties

Optional Readonly body

body: string | FormData | ArrayBuffer

Тело запроса.

Свойство body содержит данные, переданные в теле запроса, и может принимать разные формы в зависимости от типа содержимого:

  • string — строковое представление тела, обычно используется для текстовых или JSON-запросов;
  • FormData — используется при передаче данных формы, включая файлы;
  • ArrayBuffer — может использоваться для двоичных данных, например, при передаче файлов в чистом бинарном виде.

Примеры обработки:

// Обработка formData
if (!req.body) {
     return new HttpResponse(400)
}
if (req.bodyType === 'formdata') {
    const formData = <FormData>req.body;
    const fileData = <FormDataEntryFile | null>formData.get('file');

    if (fileData) {
         const name = fileData.name;
         const arrayBuffer = await fileData.arrayBuffer();
         const file = await System.files.createTemporary(name, arrayBuffer);
    } else {
        // Ошибка: файл не передан
    }
}

// Обработка строки
if (req.bodyType === 'string') {
    if (req.headers['Content-Type'] === 'application/json') {
        const jsonBody = JSON.parse(req.body); // Объект из JSON
    } else {
        const textBody = req.body; // Обычный текст
    }
}

// Обработка ArrayBuffer
if (req.bodyType === 'bytes') {
    const buffer = <ArrayBuffer>req.body;
    // Работа с двоичными данными
}

Optional Readonly bodyType

bodyType: "string" | "formdata" | "bytes"

Тип данных, находящихся в body.

Позволяет понять, что именно находится в свойстве body:

  • string — просто строка (тип string);
  • formdata — данные формы (тип FormData);
  • bytes — бинарные данные (тип ArrayBuffer).

Optional Readonly fragment

fragment: undefined | string

Дополнительная часть пути в URL метода API.

Optional Readonly headers

headers: Readonly<Record<string, string>>

Заголовки.

Readonly host

host: string

Домен или IP-адрес запроса.

Optional Readonly method

method: "GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "OPTIONS" | string

HTTP-метод запроса.

Readonly path

path: string

Относительный путь в URL метода API.

Optional Readonly port

port: undefined | number

Порт запроса.

Optional Readonly query

query: Readonly<URLSearchParams>

Параметры URL-строки для веб-запроса.

Readonly scheme

scheme: string

Протокол запроса.