← Cloudflare Workers / workers / runtime-apis

Ответ

Response интерфейс представляет HTTP-ответ и является частью Fetch API.

let response = new Response(body, init);

• body необязательный

  • Объект, определяющий текст тела ответа. Может быть null или любой из следующих типов:

    • BufferSource
    • FormData
    • ReadableStream
    • URLSearchParams
    • USVString

• init необязательный

  • Одна options объект, который содержит пользовательские настройки, применяемые к ответу.

Допустимые значения для options объект включают:

• cf any | null
  • Объект, содержащий специфичную для Cloudflare информацию. Он не входит в стандарт Fetch API и доступен только в Cloudflare Workers. Это поле используется потребителями Response исключительно в информационных целях и никак не влияет на поведение Workers.
• encodeBody строка
  • Workers обязаны сжимать данные в соответствии с content-encoding заголовка при передаче, чтобы отдавать уже сжатые данные, этому свойству нужно присвоить значение "manual", в противном случае по умолчанию используется "automatic".
• headers Headers | ByteString
  • Любые заголовки, которые нужно добавить в ответ и которые содержатся в Headers объект или объектный литерал ByteString ↗ пар «ключ-значение».
• status int
  • Код статуса ответа, например 200.
• statusText строка
  • Сообщение о статусе, связанное с кодом статуса, например, OK.
• webSocket WebSocket | null
  • Он присутствует в успешных ответах на подтверждение соединения WebSocket. Например, если клиент отправляет запрос на обновление до WebSocket на источник, а Worker перехватывает этот запрос, пересылает его источнику, и источник отвечает успешным подтверждением обновления до WebSocket, то Worker получает response.webSocket. Это устанавливает WebSocket-соединение, проксируемое через Worker. Обратите внимание, что перехватывать данные, передаваемые через WebSocket-соединение, нельзя.

• response.body Readable Stream
  • Геттер для получения содержимого тела.
• response.bodyUsed boolean
  • Логическое значение, указывающее, было ли использовано тело в ответе.
• response.headers Headers
  • Заголовки ответа.
• response.ok boolean
  • Логическое значение, указывающее, был ли ответ успешным (статус в диапазоне 200-299).
• response.redirected boolean
  • Логическое значение, указывающее, является ли ответ результатом редиректа. Если да, его список URL содержит более одной записи.
• response.status int
  • Код статуса ответа (например, 200 для обозначения успеха).
• response.statusText строка
  • Сообщение о статусе, соответствующее коду статуса (например, OK для 200).
• response.url строка
  • URL ответа. Значением является итоговый URL, полученный после всех перенаправлений.
• response.webSocket WebSocket?
  • Он присутствует в успешных ответах на подтверждение соединения WebSocket. Например, если клиент отправляет запрос на обновление до WebSocket на источник, а Worker перехватывает этот запрос, пересылает его источнику, и источник отвечает успешным подтверждением обновления до WebSocket, то Worker получает response.webSocket. Это устанавливает WebSocket-соединение, проксируемое через Worker. Обратите внимание, что перехватывать данные, передаваемые через WebSocket-соединение, нельзя.

• clone() : Response

  • Создает клон Response объект.

• json() : Response

  • Создает новый ответ с полезной нагрузкой, сериализованной в JSON.

• redirect() : Response

  • Создает новый ответ с другим URL.

Response реализует Body ↗ миксин Fetch API ↗, и поэтому Response экземпляры также имеют следующие доступные методы:

• arrayBuffer() : Promise<ArrayBuffer>

  • Принимает Response поток, считывает его до конца и возвращает promise, который разрешается с ArrayBuffer ↗.

• formData() : Promise<FormData>

  • Принимает Response поток, считывает его до конца и возвращает promise, который разрешается с FormData ↗ объект.

• json() : Promise<JSON>

  • Принимает Response поток, считывает его до конца и возвращает promise, который разрешается результатом разбора текста тела как JSON ↗.

• text() : Promise<USVString>

  • Принимает Response поток, считывает его до конца и возвращает promise, который разрешается с USVString ↗ (текст).

Content-Length заголовок автоматически устанавливается средой выполнения на основе источника данных для Response равно этому значению. Любое значение, вручную заданное пользовательским кодом в Headers будет проигнорирован. Чтобы иметь Content-Length заголовка с указанным конкретным значением body из Response должен быть либо FixedLengthStream или значение фиксированной длины, как и строка, или TypedArray.

A FixedLengthStream представляет собой идентичность TransformStream который позволяет записать в него только фиксированное количество байтов.

  const { writable, readable } = new FixedLengthStream(11);

  const enc = new TextEncoder();
  const writer = writable.getWriter();
  writer.write(enc.encode("hello world"));
  writer.end();

  return new Response(readable);

Использование любого другого типа ReadableStream в качестве тела ответа приведёт к использованию chunked encoding.

Реализация Workers для Response интерфейс включает несколько расширений веб-стандарта Response API. Эти отличия сделаны намеренно и обеспечивают дополнительные функции, специфичные для среды выполнения Workers.

Workers добавляет необязательный cf свойство в Response объект. Это свойство можно задать в ResponseInit параметры и используется в информационных целях потребителями Response. Это не влияет на поведение Workers.

Workers добавляет webSocket свойство в Response объект для поддержки WebSocket соединений. Это свойство присутствует в успешных ответах на WebSocket handshake. См. WebSockets, где это описано подробнее.

Workers добавляет encodeBody параметр в ResponseInit который определяет способ сжатия тела ответа. Установите значение "manual" при передаче предварительно сжатых данных, чтобы предотвратить автоматическое сжатие.

headers свойство возвращает специфичный для Workers Headers объект, который включает дополнительные методы, такие как getAll() для Set-Cookie заголовки. См. Документация Headers подробнее о том, как Workers Headers реализация отличается от веб-стандарта.

• Примеры: изменение ответа
• Примеры: условный ответ
• Справка: Request
• Напишите код своего Worker на синтаксис ES modules для оптимальной работы.