APIRequestContext

Этот API используется для тестирования веб-API. Вы можете использовать его для запуска API-эндпоинтов, настройки микросервисов, подготовки среды или сервиса для вашего e2e-теста.

Каждый контекст браузера Playwright имеет связанный с ним экземпляр APIRequestContext, который разделяет хранилище cookie с контекстом браузера и к которому можно получить доступ через browserContext.request или page.request. Также возможно создать новый экземпляр APIRequestContext вручную, вызвав apiRequest.newContext().

Управление cookie

APIRequestContext, возвращаемый browserContext.request и page.request, разделяет хранилище cookie с соответствующим BrowserContext. Каждый API-запрос будет иметь заголовок Cookie с заполненными значениями из контекста браузера. Если ответ API содержит заголовок Set-Cookie, он автоматически обновит cookie BrowserContext, и запросы, сделанные со страницы, их получат. Это означает, что если вы войдете в систему с помощью этого API, ваш e2e-тест также будет авторизован, и наоборот.

Если вы хотите, чтобы API-запросы не взаимодействовали с cookie браузера, вы должны создать новый APIRequestContext, вызвав apiRequest.newContext(). Такой APIRequestContext объект будет иметь собственное изолированное хранилище cookie.

Методы

delete

Отправляет HTTP(S) DELETE запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически перенаправит на новую страницу.

Использование

await apiRequestContext.delete(url);
await apiRequestContext.delete(url, options);

Аргументы

url строка

Целевой URL.
options Объект (необязательно)
- data строка | Буфер | Сериализуемый (необязательно)
  
  Позволяет установить данные тела запроса. Если параметр данных является объектом, он будет сериализован в строку json, и content-type заголовок будет установлен на application/json, если не задан явно. В противном случае content-type заголовок будет установлен на application/octet-stream, если не задан явно.
- failOnStatusCode логическое значение (необязательно)
  
  Бросить исключение при кодах ответа, отличных от 2xx и 3xx. По умолчанию возвращается объект ответа для всех кодов состояния.
- form Объект<строка, строка | число | логическое значение> | FormData (необязательно)
  
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, content-type заголовок будет установлен на application/x-www-form-urlencoded, если не задан явно.
- headers Объект<строка, строка> (необязательно)
  
  Позволяет установить HTTP-заголовки. Эти заголовки будут применены к полученному запросу, а также к любым перенаправлениям, инициированным им.
- ignoreHTTPSErrors логическое значение (необязательно)
  
  Игнорировать ошибки HTTPS при отправке сетевых запросов. По умолчанию false.
- maxRedirects число (необязательно)
  
  Максимальное количество перенаправлений запросов, которые будут автоматически следовать. Если число будет превышено, будет выброшено исключение. По умолчанию 20. Передайте 0, чтобы не перенаправлять.
- maxRetries число (необязательно)
  
  Максимальное количество попыток повторного выполнения сетевых ошибок. В настоящее время только ошибка ECONNRESET повторяется. Не повторяет на основе HTTP-кодов ответа. Если предел будет превышен, будет выброшено исключение. По умолчанию 0 - без повторов.
- multipart FormData | Объект<строка, строка | число | логическое значение | Поток чтения | Объект> (необязательно)
  - name строка
    
    Имя файла
  - mimeType строка
    
    Тип файла
  - buffer Буфер
    
    Содержание файла
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки multipart/form-data и отправлен в качестве тела этого запроса. Если этот параметр указан, content-type заголовок будет установлен на multipart/form-data, если не задан явно. Значения файлов можно передавать как fs.ReadStream или как объект, похожий на файл, содержащий имя файла, тип MIME и его содержимое.
- params Объект<строка, строка | число | логическое значение> | URLSearchParams | строка (необязательно)
  
  Параметры запроса, которые необходимо отправить с URL.
- timeout число (необязательно)
  
  Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить таймаут.

Возвращает

Promise<APIResponse>

dispose

Все ответы, возвращаемые методом apiRequestContext.get() и аналогичными методами, хранятся в памяти, чтобы вы могли позже вызвать метод apiResponse.body(). Этот метод удаляет все свои ресурсы, и вызов любого метода на экземпляре APIRequestContext, который был удалён, приведёт к исключению.

Использование

await apiRequestContext.dispose();
await apiRequestContext.dispose(options);

Аргументы

options Объект (необязательно)
- reason строка (необязательно)
  
  Причина, которая будет передана операциям, прерванным из-за удаления контекста.

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

Promise<void>

fetch

Отправляет HTTP(S) запрос и возвращает его ответ. Метод заполняет куки запроса из контекста и обновляет куки контекста из ответа. Метод автоматически обрабатывает переадресации.

Использование

JSON-объекты могут быть переданы напрямую в запросе:

await request.fetch('https://example.com/api/createBook', {
  method: 'post',
  data: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

Обычный способ отправки файлов в теле запроса — загрузить их как поля формы с использованием multipart/form-data кодировки, указав параметр multipart.

const form = new FormData();
form.set('name', 'John');
form.append('name', 'Doe');
// Send two file fields with the same name.
form.append('file', new File(['console.log(2024);'], 'f1.js', { type: 'text/javascript' }));
form.append('file', new File(['hello'], 'f2.txt', { type: 'text/plain' }));
await request.fetch('https://example.com/api/uploadForm', {
  multipart: form
});

Аргументы

urlOrRequest строка | Запрос

Целевой URL или запрос для получения всех параметров.
options Объект (необязательно)
- data строка | Буфер | Сериализуемый (необязательно)
  
  Позволяет установить данные POST-запроса. Если параметр data является объектом, он будет сериализован в строку JSON, и заголовок content-type будет установлен в значение application/json, если не задан явно. В противном случае заголовок content-type будет установлен в application/octet-stream, если не задан явно.
- failOnStatusCode логическое значение (необязательно)
  
  Вызывать исключение при кодах ответа, отличных от 2xx и 3xx. По умолчанию объект ответа возвращается для всех кодов статуса.
- form Объект<строка, строка | число | логическое значение> | FormData (необязательно)
  
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в значение application/x-www-form-urlencoded, если не указано явно.
- headers Объект<строка, строка> (необязательно)
  
  Позволяет задавать HTTP-заголовки. Эти заголовки будут применяться к полученному запросу, а также к любым перенаправлениям, инициированным им.
- ignoreHTTPSErrors логическое значение (необязательно)
  
  Игнорировать ошибки HTTPS при отправке сетевых запросов. По умолчанию false.
- maxRedirects число (необязательно)
  
  Максимальное количество перенаправлений запроса, которые будут автоматически следовать. Если это количество будет превышено, будет выброшено исключение. По умолчанию 20. Передайте 0, чтобы не следовать перенаправлениям.
- maxRetries число (необязательно)
  
  Максимальное количество попыток повторной отправки сетевых запросов в случае ошибок. В настоящее время пересылается только ошибка ECONNRESET. Не повторяет попытки на основе кодов HTTP-ответа. Если лимит будет превышен, будет выброшено исключение. По умолчанию 0 — нет повторов.
- method строка (необязательно)
  
  При указании изменяет метод fetch (например, PUT или POST). Если не указано, используется метод GET.
- multipart FormData | Объект<строка, строка | число | логическое значение | ReadStream | Объект> (необязательно)
  - name строка
    
    Имя файла
  - mimeType строка
    
    Тип файла
  - buffer Буфер
    
    Содержание файла
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки multipart/form-data и отправлен в качестве тела запроса. Если этот параметр указан, заголовок content-type будет установлен в multipart/form-data, если не задан явно. Значения файлов можно передавать либо как fs.ReadStream, либо как похожий на файл объект, содержащий имя файла, тип MIME и его содержимое.
- params Объект<строка, строка | число | логическое значение> | URLSearchParams | строка (необязательно)
  
  Параметры запроса, которые должны быть отправлены вместе с URL.
- timeout число (необязательно)
  
  Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0 для отключения таймаута.

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

Обещание<APIResponse>

get

Отправляет HTTP(S) GET запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически будет следовать перенаправлениям.

Использование

Параметры запроса можно настроить с помощью параметра params, они будут сериализованы в параметры поиска URL:

// Passing params as object
await request.get('https://example.com/api/getText', {
  params: {
    'isbn': '1234',
    'page': 23,
  }
});

// Passing params as URLSearchParams
const searchParams = new URLSearchParams();
searchParams.set('isbn', '1234');
searchParams.append('page', 23);
searchParams.append('page', 24);
await request.get('https://example.com/api/getText', { params: searchParams });

// Passing params as string
const queryString = 'isbn=1234&page=23&page=24';
await request.get('https://example.com/api/getText', { params: queryString });

Аргументы

url string

Целевой URL.
options Объект (необязательно)
- data строка | Буфер | Сериализуемый (необязательно)
  
  Позволяет установить данные тела запроса. Если параметр data — объект, он будет сериализован в строку JSON, и заголовок content-type будет установлен в значение application/json, если не задан явно. В противном случае заголовок content-type будет установлен в значение application/octet-stream, если не задан явно.
- failOnStatusCode логическое (необязательно)
  
  Выбрасывать ли исключение при кодах ответа, отличных от 2xx и 3xx. По умолчанию объект ответа возвращается для всех кодов статуса.
- form Объект<строка, строка | число | логическое> | FormData (необязательно)
  
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела запроса. Если этот параметр указан, заголовок content-type будет установлен в значение application/x-www-form-urlencoded, если не задан явно.
- headers Объект<строка, строка> (необязательно)
  
  Позволяет установить HTTP-заголовки. Эти заголовки будут применены к запросу, а также к любым перенаправлениям, инициированным им.
- ignoreHTTPSErrors логическое (необязательно)
  
  Игнорировать ли ошибки HTTPS при отправке сетевых запросов. По умолчанию false.
- maxRedirects число (необязательно)
  
  Максимальное количество перенаправлений запросов, которые будут следовать автоматически. Если это число будет превышено, будет выброшено исключение. По умолчанию 20. Передайте 0 для того, чтобы не следовать перенаправлениям.
- maxRetries число (необязательно)
  
  Максимальное количество попыток повторного выполнения сетевых ошибок. В настоящее время перепробывается только ошибка ECONNRESET. Не повторяет попытки на основе HTTP-кодов ответа. Если предел будет превышен, будет выброшено исключение. По умолчанию 0 — нет повторных попыток.
- multipart FormData | Объект<строка, строка | число | логическое | Поток чтения | Объект> (необязательно)
  - name строка
    
    Имя файла
  - mimeType строка
    
    Тип файла
  - buffer Буфер
    
    Содержимое файла
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки multipart/form-data и отправлен в качестве тела запроса. Если этот параметр указан, заголовок content-type будет установлен в значение multipart/form-data, если не задан явно. Значения файлов могут быть переданы как fs.ReadStream или как объект, подобный файлу, содержащий имя файла, тип MIME и его содержимое.
- params Объект<строка, строка | число | логическое> | URLSearchParams | строка (необязательно)
  
  Параметры запроса, которые будут отправлены вместе с URL.
- timeout число (необязательно)
  
  Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0 для отключения таймаута.

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

Promise<APIResponse>

head

Отправляет HTTP(S) запрос HEAD и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод будет автоматически следовать перенаправлениям.

Использование

await apiRequestContext.head(url);
await apiRequestContext.head(url, options);

Аргументы

url string

Целевой URL.
options Объект (необязательно)
- data строка | Буфер | Сериализуемый (необязательно)
  
  Позволяет установить данные POST-запроса. Если параметр data является объектом, он будет сериализован в строку JSON, и заголовок content-type будет установлен на значение application/json, если не установлен явно. В противном случае заголовок content-type будет установлен на значение application/octet-stream, если не установлен явно.
- failOnStatusCode логическое значение (необязательно)
  
  Выбрасывать исключение при кодах ответа, отличных от 2xx и 3xx. По умолчанию для всех кодов статуса возвращается объект ответа.
- form Объект<строка, строка | число | логическое значение> | FormData (необязательно)
  
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен на application/x-www-form-urlencoded, если не задан явно.
- headers Объект<строка, строка> (необязательно)
  
  Позволяет устанавливать HTTP-заголовки. Эти заголовки будут применены к полученному запросу, а также к любым редиректам, инициированным им.
- ignoreHTTPSErrors логическое значение (необязательно)
  
  Игнорировать ошибки HTTPS при отправке сетевых запросов. По умолчанию false.
- maxRedirects число (необязательно)
  
  Максимальное количество редиректов запроса, которые будут следовать автоматически. Если предел будет превышен, будет выброшено исключение. По умолчанию 20. Передайте 0, чтобы не следовать редиректам.
- maxRetries число (необязательно)
  
  Максимальное количество попыток повторной отправки сетевых запросов при ошибках. В настоящее время пересылается только ошибка ECONNRESET. Не повторяет попытки на основе HTTP-кодов ответа. Если предел будет превышен, будет выброшено исключение. По умолчанию 0 — без повторных попыток.
- multipart FormData | Объект<строка, строка | число | логическое значение | Поток чтения | Объект> (необязательно)
  - name строка
    
    Имя файла
  - mimeType строка
    
    Тип файла
  - buffer Буфер
    
    Содержание файла
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки multipart/form-data и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен на multipart/form-data если не задан явно. Значения файлов могут быть переданы либо как fs.ReadStream, либо как похожий на файл объект, содержащий имя файла, тип MIME и его содержимое.
- params Объект<строка, строка | число | логическое значение> | URLSearchParams | строка (необязательно)
  
  Параметры запроса, которые будут отправлены вместе с URL.
- timeout число (необязательно)
  
  Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0 для отключения таймаута.

Возвращает

Promise<APIResponse>

patch

Отправляет HTTP(S) PATCH запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически будет следовать редиректам.

Использование

await apiRequestContext.patch(url);
await apiRequestContext.patch(url, options);

Аргументы

url строка

Целевой URL.
options Объект (необязательно)
- data строка | Буфер | Сериализуемый (необязательно)
  
  Позволяет задать данные POST-запроса. Если параметр data является объектом, он будет сериализован в строку JSON, и заголовок content-type будет установлен на application/json, если не задан явно. В противном случае заголовок content-type будет установлен на application/octet-stream, если не задан явно.
- failOnStatusCode логическое (необязательно)
  
  Выбрасывать ли исключение при кодах ответа, отличных от 2xx и 3xx. По умолчанию объект ответа возвращается для всех кодов состояния.
- form Объект<строка, строка | число | логическое> | FormData (необязательно)
  
  Предоставляет объект, который будет сериализован как форма HTML с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен на application/x-www-form-urlencoded, если не задан явно.
- headers Объект<строка, строка> (необязательно)
  
  Позволяет задать HTTP-заголовки. Эти заголовки будут применены к полученному запросу, а также к любым редиректам, инициированным им.
- ignoreHTTPSErrors логическое (необязательно)
  
  Игнорировать ли ошибки HTTPS при отправке сетевых запросов. По умолчанию false.
- maxRedirects число (необязательно)
  
  Максимальное количество редиректов запроса, которые будут автоматически следовать. Если это число будет превышено, будет выброшено исключение. По умолчанию 20. Передайте 0, чтобы не следовать редиректам.
- maxRetries число (необязательно)
  
  Максимальное количество попыток повторной отправки сетевых ошибок. В настоящее время пересылается только ошибка ECONNRESET. Не повторяется на основе HTTP-кодов ответа. Если предел будет превышен, будет выброшено исключение. По умолчанию 0 — нет повторов.
- multipart FormData | Объект<строка, строка | число | логическое | Поток чтения | Объект> (необязательно)
  - name строка
    
    Имя файла
  - mimeType строка
    
    Тип файла
  - buffer Буфер
    
    Содержимое файла
  Предоставляет объект, который будет сериализован как форма HTML с использованием кодировки multipart/form-data и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен на multipart/form-data, если не задан явно. Значения файлов могут быть переданы как fs.ReadStream или как объект, подобный файлу, содержащий имя файла, тип MIME и его содержимое.
- params Объект<строка, строка | число | логическое> | URLSearchParams | строка (необязательно)
  
  Параметры запроса, которые должны быть отправлены с URL.
- timeout число (необязательно)
  
  Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить таймаут.

Возвращает

Обещание<APIResponse>

post

Отправляет HTTP(S) POST-запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически будет следовать редиректам.

Использование

Объекты JSON могут быть переданы непосредственно в запрос:

await request.post('https://example.com/api/createBook', {
  data: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

Для отправки данных формы на сервер используйте параметр form. Его значение будет закодировано в тело запроса с использованием кодировки application/x-www-form-urlencoded (см. ниже, как использовать кодировку формы multipart/form-data для отправки файлов):

await request.post('https://example.com/api/findBook', {
  form: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

Общий способ отправки файла(ов) в теле запроса — загрузить их как поля формы с кодировкой multipart/form-data. Используйте FormData для построения тела запроса и передачи его в запрос в качестве параметра multipart.

const form = new FormData();
form.set('name', 'John');
form.append('name', 'Doe');
// Send two file fields with the same name.
form.append('file', new File(['console.log(2024);'], 'f1.js', { type: 'text/javascript' }));
form.append('file', new File(['hello'], 'f2.txt', { type: 'text/plain' }));
await request.post('https://example.com/api/uploadForm', {
  multipart: form
});

Аргументы

url строка

Целевой URL.
options Объект (необязательно)
- data строка | Буфер | Сериализуемый (необязательно)
  
  Позволяет задать данные тела запроса. Если параметр data является объектом, он будет сериализован в строку JSON, и заголовок content-type будет установлен на значение application/json, если не задан явно. В противном случае, заголовок content-type будет установлен на значение application/octet-stream, если не задан явно.
- failOnStatusCode логическое (необязательно)
  
  Выбрасывать исключение при кодах ответа, отличных от 2xx и 3xx. По умолчанию для всех кодов состояния возвращается объект ответа.
- form Объект<строка, строка | число | логическое> | FormData (необязательно)
  
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела запроса. Если этот параметр указан, заголовок content-type будет установлен на значение application/x-www-form-urlencoded, если не задан явно.
- headers Объект<строка, строка> (необязательно)
  
  Позволяет задать HTTP-заголовки. Эти заголовки будут применены к запросу, а также к любым редиректам, инициированным им.
- ignoreHTTPSErrors логическое (необязательно)
  
  Игнорировать ошибки HTTPS при отправке сетевых запросов. По умолчанию значение false.
- maxRedirects число (необязательно)
  
  Максимальное количество редиректов запроса, которые будут автоматически отслежены. Если это число будет превышено, будет выброшено исключение. По умолчанию 20. Передайте 0 для отключения отслеживания редиректов.
- maxRetries число (необязательно)
  
  Максимальное количество попыток повторного выполнения сетевых ошибок. В настоящее время перепроверяется только ошибка ECONNRESET. Не перепроверяет на основе кодов HTTP-ответа. Если предел будет превышен, будет выброшено исключение. По умолчанию 0 - без повторных попыток.
- multipart FormData | Объект<строка, строка | число | логическое | Поток чтения | Объект> (необязательно)
  - name строка
    
    Имя файла
  - mimeType строка
    
    Тип файла
  - buffer Буфер
    
    Содержание файла
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки multipart/form-data и отправлен в качестве тела запроса. Если этот параметр указан, заголовок content-type будет установлен на значение multipart/form-data , если не задан явно. Значения файлов можно передавать либо как fs.ReadStream, либо как объект, похожий на файл, содержащий имя файла, тип MIME и его содержимое.
- params Объект<строка, строка | число | логическое> | URLSearchParams | строка (необязательно)
  
  Параметры запроса, которые должны быть отправлены с URL.
- timeout число (необязательно)
  
  Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0 для отключения таймаута.

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

Promise<APIResponse>

put

Отправляет HTTP(S) PUT запрос и возвращает его ответ. Метод заполнит куки запроса из контекста и обновит куки контекста из ответа. Метод автоматически выполнит редиректы.

Использование

await apiRequestContext.put(url);
await apiRequestContext.put(url, options);

Аргументы

url строка

Целевой URL.
options Объект (необязательно)
- data строка | Буфер | Сериализуемый (необязательно)
  
  Позволяет установить данные POST-запроса. Если параметр data является объектом, он будет сериализован в строку JSON, и заголовок content-type будет установлен в application/json, если не задан явно. В противном случае заголовок content-type будет установлен в application/octet-stream, если не задан явно.
- failOnStatusCode логическое (необязательно)
  
  Бросить исключение при кодах ответа, отличных от 2xx и 3xx. По умолчанию объект ответа возвращается для всех кодов состояния.
- form Объект<строка, строка | число | логическое> | FormData (необязательно)
  
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки application/x-www-form-urlencoded и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в application/x-www-form-urlencoded, если не указан явно.
- headers Объект<строка, строка> (необязательно)
  
  Позволяет задать HTTP-заголовки. Эти заголовки будут применяться к запросу, а также к любому перенаправлению, инициированному им.
- ignoreHTTPSErrors логическое (необязательно)
  
  Игнорировать ошибки HTTPS при отправке сетевых запросов. По умолчанию false.
- maxRedirects число (необязательно)
  
  Максимальное количество перенаправлений запросов, которые будут следовать автоматически. Если предел будет превышен, будет выброшено исключение. По умолчанию 20. Передайте 0, чтобы не следовать перенаправлениям.
- maxRetries число (необязательно)
  
  Максимальное количество попыток повтора сетевых ошибок. В настоящее время перепробовывается только ошибка ECONNRESET. Не повторяет попытки на основе HTTP-кодов ответа. Если предел будет превышен, будет выброшено исключение. По умолчанию 0 - нет повторов.
- multipart FormData | Объект<строка, строка | число | логическое | Поток чтения | Объект> (необязательно)
  - name строка
    
    Имя файла
  - mimeType строка
    
    Тип файла
  - buffer Буфер
    
    Содержимое файла
  Предоставляет объект, который будет сериализован как HTML-форма с использованием кодировки multipart/form-data и отправлен в качестве тела этого запроса. Если этот параметр указан, заголовок content-type будет установлен в multipart/form-data, если не указан явно. Значения файлов могут быть переданы либо как fs.ReadStream, либо как похожий на файл объект, содержащий имя файла, тип MIME и его содержимое.
- params Объект<строка, строка | число | логическое> | URLSearchParams | строка (необязательно)
  
  Параметры запроса, которые должны быть отправлены вместе с URL.
- timeout число (необязательно)
  
  Таймаут запроса в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0 для отключения таймаута.

Возвращает

Обещание<APIResponse>

storageState

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

Использование

await apiRequestContext.storageState();
await apiRequestContext.storageState(options);

Аргументы

options Объект (необязательно)
- path строка (необязательно)
  
  Путь к файлу для сохранения состояния хранилища. Если путь path является относительным, он разрешается относительно текущего рабочего каталога. Если путь не указан, состояние хранилища всё равно возвращается, но не будет сохранено на диск.

Возвращает

Promise<Объект>
- cookies Массив<Объект>
  - name строка
  - value строка
  - domain строка
  - path строка
  - expires число
    
    Время Unix в секундах.
  - httpOnly логическое
  - secure логическое
  - sameSite "Строгий" | "Свободный" | "Нет"
- origins Массив<Объект>
  - origin строка
  - localStorage Массив<Объект>
    - name строка
    - value строка

Методы​

delete​

dispose​

fetch​

get​

head​

patch​

post​

put​

storageState​

Методы

delete

dispose

fetch

get

head

patch

post

put

storageState