Метод POST

Метод post используется для отправки HTTP-запросов типа POST. Он принимает URL, данные и опциональные параметры запроса, возвращая результат обработки запроса сервером.

Перегрузки функции `post`

declare function reqPost(url: string, data?: BodyData, options?: NoMethod<TextResponseOptions>): Promise<Response<string>>;

url: string строка, представляющая URL-адрес ресурса.
data: BodyData — данные для отправки.
options: NoMethod<TextResponseOptions> — опциональные параметры запроса.

Возвращает объект Response<string>.

Свойства

url: `string`

URL-адрес ресурса, к которому делается запрос.

Примеры значений:

'https://data.chatium.com/samples/menu.json'

data: `BodyData`

Данные, которые отправляются в теле запроса. Тип данных может быть следующим:

string
Record<string, unknown>
unknown[]
null

Примеры значений:

'{ "name": "John", "age": 30 }'
[1, "string", true, { key: "value" }]

options

Опциональный объект, содержащий параметры запроса.

Свойства объекта options

headers: Record<string, string | string[] | undefined>

Заголовки HTTP-запроса.

Пример значения:
```
{
  'Content-Type': 'application/json',
  'Authorization': 'Bearer token'
}
```
searchParams: string | Record<string, string | number | boolean | null | undefined>

Параметры строки запроса.

Пример значения:
```
{
  lang: 'en',
  page: 1
}
```
responseType: 'json' | 'text'

Тип данных в ответе.
timeout: number

Время ожидания запроса в миллисекундах.

Пример значения:
```
5000
```

Возвращаемое значение

Ответ от сервера.

Response

Объект ответа от сервера.

Свойства объекта Response

body:

Тело ответа, тип определяется при вызове функции.
statusCode: number

Код статуса HTTP.
headers: Record<string, string>

Заголовки ответа.

Пример

Рассмотрим пример использования метода POST для добавления нового элемента в меню. Для этого используется библиотека для отправки HTTP запросов.

Эта асинхронная функция отправляет POST запрос на указанный URL и возвращает результат обработки запроса сервером.

Документация