http2

Свойство request.aborted будет иметь значение true, если запрос был прерван.

Псевдополе заголовка authority запроса. Поскольку HTTP/2 позволяет задавать в запросах либо :authority, либо host, это значение определяется на основе req.headers[':authority'], если оно задано. В противном случае оно определяется на основе req.headers['host'].

Свойство request.complete будет иметь значение true, если запрос был завершён, прерван или уничтожен.

См. request.socket.

Объект заголовков запроса/ответа.

Пары «ключ—значение», содержащие имена и значения заголовков. Имена заголовков приводятся к нижнему регистру.

// Prints something like:
//
// { 'user-agent': 'curl/7.22.0',
//   host: '127.0.0.1:8000',
//   accept: '*' }
console.log(request.headers);

См. HTTP/2 Headers Object.

В HTTP/2 путь запроса, имя хоста, протокол и метод представлены специальными заголовками с префиксом в виде символа : (например, ':path'). Эти специальные заголовки включаются в объект request.headers. Необходимо следить за тем, чтобы случайно не изменять эти специальные заголовки, иначе могут возникнуть ошибки. Например, удаление всех заголовков запроса приведёт к ошибкам:

removeAllHeaders(request.headers);
assert(request.url);   // Fails because the :path header has been removed

Для запроса сервера — версия HTTP, отправленная клиентом. Для ответа клиента — версия HTTP подключённого сервера. Возвращает '2.0'.

Кроме того, message.httpVersionMajor — это первое целое число, а message.httpVersionMinor — второе.

Метод запроса в виде строки. Только для чтения. Примеры: 'GET', 'DELETE'.

Список исходных заголовков запроса/ответа в точности в том виде, в каком они были получены.

Ключи и значения находятся в одном списке. Это не список кортежей. Таким образом, элементы с чётными индексами являются ключами, а элементы с нечётными индексами — соответствующими значениями.

Имена заголовков не приводятся к нижнему регистру, а дубликаты не объединяются.

// Prints something like:
//
// [ 'user-agent',
//   'this is invalid because there can be only one',
//   'User-Agent',
//   'curl/7.22.0',
//   'Host',
//   '127.0.0.1:8000',
//   'ACCEPT',
//   '*' ]
console.log(request.rawHeaders);

Исходные ключи и значения трейлеров запроса/ответа в точности в том виде, в каком они были получены. Заполняется только при событии 'end'.

Псевдополе заголовка scheme запроса, указывающее часть целевого URL, содержащую схему.

Возвращает объект Proxy, который действует как net.Socket (или tls.TLSSocket), но применяет геттеры, сеттеры и методы с учётом логики HTTP/2.

Свойства destroyed, readable и writable считываются из request.stream и задаются для него.

Методы destroy, emit, end, on и once вызываются для request.stream.

Метод setTimeout вызывается для request.stream.session.

При обращении к pause, read, resume и write будет вызвана ошибка с кодом ERR_HTTP2_NO_SOCKET_MANIPULATION. Дополнительные сведения см. в разделе Http2Session and Sockets.

Все остальные операции напрямую перенаправляются сокету. При использовании TLS вызовите request.socket.getPeerCertificate(), чтобы получить данные аутентификации клиента.

Объект Http2Stream, лежащий в основе запроса.

Объект трейлеров запроса/ответа. Заполняется только при событии 'end'.

Строка URL запроса. Она содержит только URL, указанный в фактическом HTTP-запросе. Если запрос имеет вид:

GET /status?name=ryan HTTP/1.1
Accept: text/plain

Тогда request.url будет иметь значение:

'/status?name=ryan'

Чтобы разобрать URL на составляющие, можно использовать new URL():

$ node
> new URL('/status?name=ryan', 'http://example.com')
URL {
  href: 'http://example.com/status?name=ryan',
  origin: 'http://example.com',
  protocol: 'http:',
  username: '',
  password: '',
  host: 'example.com',
  hostname: 'example.com',
  port: '',
  pathname: '/status',
  search: '?name=ryan',
  searchParams: URLSearchParams { 'name' => 'ryan' },
  hash: ''
}

Задаёт значение тайм-аута для Http2Stream равным msecs. Если указан callback, он добавляется в качестве обработчика события 'timeout' объекта ответа.

Если к запросу, ответу или серверу не добавлен обработчик события 'timeout', то Http2Stream уничтожаются по истечении тайм-аута. Если для событий 'timeout' запроса, ответа или сервера назначен обработчик, сокеты с истёкшим временем ожидания необходимо обрабатывать явно.

См. response.socket.

Логическое значение, указывающее, завершена ли отправка ответа. Изначально имеет значение false. После выполнения response.end() значение станет true.

Значение true, если заголовки были отправлены, и false в противном случае (только для чтения).

Ссылка на исходный объект HTTP2 request.

Если имеет значение true, заголовок Date будет автоматически сформирован и отправлен в ответе, если он еще не присутствует в заголовках. По умолчанию — true.

Отключать это следует только при тестировании; протокол HTTP требует наличия заголовка Date в ответах.

Возвращает объект Proxy, который действует как net.Socket (или tls.TLSSocket), но применяет геттеры, сеттеры и методы в соответствии с логикой HTTP/2.

Свойства destroyed, readable и writable будут получены из response.stream и заданы для него.

Методы destroy, emit, end, on и once будут вызваны для response.stream.

Метод setTimeout будет вызван для response.stream.session.

Вызов pause, read, resume и write приведет к ошибке с кодом ERR_HTTP2_NO_SOCKET_MANIPULATION. Дополнительные сведения см. в Http2Session and Sockets.

Все остальные операции будут напрямую перенаправлены сокету.

import http2 from 'node:http2';
const server = http2.createServer((req, res) => {
  const ip = req.socket.remoteAddress;
  const port = req.socket.remotePort;
  res.end(`Your IP address is ${ip} and your source port is ${port}.`);
}).listen(3000);

При использовании неявных заголовков (если явно не вызывается response.writeHead()) это свойство задает код состояния, который будет отправлен клиенту при сбросе заголовков.

response.statusCode = 404;

После отправки заголовков ответа клиенту это свойство указывает отправленный код состояния.

Сообщение о состоянии не поддерживается в HTTP/2 (RFC 7540 8.1.2.4). Возвращается пустая строка.

Объект Http2Stream, лежащий в основе ответа.

Этот метод добавляет к ответу завершающие заголовки HTTP (заголовки, расположенные в конце сообщения).

Попытка задать имя или значение поля заголовка, содержащее недопустимые символы, приведет к возникновению исключения TypeError.

Добавляет одно значение заголовка в объект заголовков.

Если значение представляет собой массив, это равносильно многократному вызову данного метода.

Если для заголовка еще нет значений, это равносильно вызову setHeader.

Попытка задать имя или значение поля заголовка, содержащее недопустимые символы, приведет к возникновению исключения TypeError.

// Returns headers including "set-cookie: a" and "set-cookie: b"
const server = http2.createServer((req, res) => {
  res.setHeader('set-cookie', 'a');
  res.appendHeader('set-cookie', 'b');
  res.writeHead(200);
  res.end('ok');
});

Вызывает http2stream.pushStream() с заданными заголовками и в случае успеха передает указанный Http2Stream в качестве параметра обратного вызова для вновь созданного Http2ServerResponse. Если Http2ServerRequest закрывается, обратный вызов вызывается с ошибкой ERR_HTTP2_INVALID_STREAM.

Этот метод сообщает серверу, что все заголовки и тело ответа отправлены и сервер должен считать это сообщение завершенным. Метод response.end() ОБЯЗАТЕЛЬНО должен быть вызван для каждого ответа.

Если указан data, это равносильно вызову response.write(data, encoding), за которым следует response.end(callback).

Если указан callback, он будет вызван после завершения потока ответа.

Читает заголовок, который уже поставлен в очередь, но еще не отправлен клиенту. Регистр символов в имени не учитывается.

const contentType = response.getHeader('content-type');

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

response.setHeader('Foo', 'bar');
response.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);

const headerNames = response.getHeaderNames();
// headerNames === ['foo', 'set-cookie']

Возвращает поверхностную копию текущих исходящих заголовков. Поскольку используется поверхностная копия, значения-массивы можно изменять без дополнительных вызовов различных методов модуля http, связанных с заголовками. Ключи возвращаемого объекта — имена заголовков, а значения — соответствующие значения заголовков. Все имена заголовков записаны строчными буквами.

Объект, возвращаемый методом response.getHeaders(), не наследует прототип от объекта JavaScript Object. Это означает, что стандартные методы Object, такие как obj.toString(), obj.hasOwnProperty() и другие, не определены и не будут работать.

response.setHeader('Foo', 'bar');
response.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']);

const headers = response.getHeaders();
// headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] }

Возвращает true, если заголовок с именем name в данный момент задан среди исходящих заголовков. Регистр символов в имени заголовка не учитывается.

const hasContentType = response.hasHeader('content-type');

Удаляет заголовок, поставленный в очередь для неявной отправки.

response.removeHeader('Content-Encoding');

Задает одно значение заголовка для неявных заголовков. Если такой заголовок уже есть среди заголовков, предназначенных для отправки, его значение будет заменено. Чтобы отправить несколько заголовков с одинаковым именем, используйте массив строк.

response.setHeader('Content-Type', 'text/html; charset=utf-8');

или

response.setHeader('Set-Cookie', ['type=ninja', 'language=javascript']);

Попытка задать имя или значение поля заголовка, содержащее недопустимые символы, приведет к возникновению исключения TypeError.

Заголовки, заданные с помощью response.setHeader(), будут объединены с заголовками, переданными в response.writeHead(); при этом приоритет будет отдан заголовкам, переданным в response.writeHead().

// Returns content-type = text/plain
const server = http2.createServer((req, res) => {
  res.setHeader('Content-Type', 'text/html; charset=utf-8');
  res.setHeader('X-Foo', 'bar');
  res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
  res.end('ok');
});

Задает значение времени ожидания для Http2Stream — msecs. Если указан обратный вызов, он добавляется в качестве обработчика события 'timeout' объекта ответа.

Если для запроса, ответа или сервера не добавлен обработчик события 'timeout', то по истечении времени ожидания Http2Stream уничтожаются. Если для событий 'timeout' запроса, ответа или сервера назначен обработчик, необходимо самостоятельно обрабатывать сокеты, для которых истекло время ожидания.

Если этот метод вызван, а response.writeHead() еще не вызывался, будет выполнен переход в режим неявных заголовков и сброс неявных заголовков.

Отправляет фрагмент тела ответа. Этот метод можно вызывать несколько раз для отправки последовательных частей тела.

В модуле node:http тело ответа не отправляется, если запрос является запросом HEAD. Аналогично, ответы 204 и 304 не должны содержать тело сообщения.

chunk может быть строкой или буфером. Если chunk является строкой, второй параметр определяет способ ее кодирования в поток байтов. По умолчанию encoding имеет значение 'utf8'. callback будет вызван, когда этот фрагмент данных будет сброшен.

Это необработанное тело HTTP, не связанное с кодированием составного тела более высокого уровня, которое может использоваться.

При первом вызове response.write() клиенту отправляются буферизованные заголовки и первый фрагмент тела. При втором вызове response.write() Node.js предполагает, что данные будут передаваться потоком, и отправляет новые данные отдельно. Иными словами, ответ буферизуется вплоть до первого фрагмента тела.

Возвращает true, если все данные успешно сброшены в буфер ядра. Возвращает false, если все данные или их часть помещены в очередь в памяти пользователя. Событие 'drain' будет сгенерировано, когда буфер снова освободится.

Отправляет клиенту статус 100 Continue, указывающий, что тело запроса следует отправить. См. событие 'checkContinue' в Http2Server и Http2SecureServer.

Отправляет клиенту статус 103 Early Hints с заголовком Link, указывая, что пользовательский агент может предварительно загрузить связанные ресурсы или установить с ними предварительное соединение. hints — это объект, содержащий значения заголовков, отправляемых в сообщении с ранними подсказками.

Пример

const earlyHintsLink = '</styles.css>; rel=preload; as=style';
response.writeEarlyHints({
  'link': earlyHintsLink,
});

const earlyHintsLinks = [
  '</styles.css>; rel=preload; as=style',
  '</scripts.js>; rel=preload; as=script',
];
response.writeEarlyHints({
  'link': earlyHintsLinks,
});

Отправляет заголовок ответа на запрос. Код состояния — это трехзначный код состояния HTTP, например 404. Последний аргумент, headers, содержит заголовки ответа.

Возвращает ссылку на Http2ServerResponse, что позволяет объединять вызовы в цепочку.

Для совместимости с HTTP/1 в качестве второго аргумента можно передать удобочитаемое statusMessage. Однако, поскольку statusMessage не имеет значения в HTTP/2, аргумент не повлияет на результат, и будет выдано предупреждение процесса.

const body = 'hello world';
response.writeHead(200, {
  'Content-Length': Buffer.byteLength(body),
  'Content-Type': 'text/plain; charset=utf-8',
});

Content-Length задается в байтах, а не в символах. API Buffer.byteLength() можно использовать для определения количества байтов в заданной кодировке. В исходящих сообщениях Node.js не проверяет, совпадает ли Content-Length с длиной передаваемого тела. Однако при получении сообщений Node.js автоматически отклоняет сообщения, если Content-Length не соответствует фактическому размеру полезной нагрузки.

Этот метод можно вызвать для сообщения не более одного раза до вызова response.end().

Если response.write() или response.end() вызваны до этого метода, неявные/изменяемые заголовки будут вычислены и вызовут эту функцию.

Заголовки, заданные с помощью response.setHeader(), будут объединены с заголовками, переданными в response.writeHead(); при этом приоритет будет отдан заголовкам, переданным в response.writeHead().

// Returns content-type = text/plain
const server = http2.createServer((req, res) => {
  res.setHeader('Content-Type', 'text/html; charset=utf-8');
  res.setHeader('X-Foo', 'bar');
  res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' });
  res.end('ok');
});

Попытка задать имя или значение поля заголовка, содержащее недопустимые символы, приведет к возникновению исключения TypeError.

Только для экземпляров клиента HTTP/2 Http2Session метод http2session.request() создаёт и возвращает экземпляр Http2Stream, который можно использовать для отправки запроса HTTP/2 подключённому серверу.

При первом создании ClientHttp2Session сокет может быть ещё не подключён. Если в это время вызывается clienthttp2session.request(), фактический запрос будет отложен до готовности сокета. Если session будет закрыт до выполнения фактического запроса, возникнет ошибка ERR_HTTP2_GOAWAY_SESSION.

Этот метод доступен только в том случае, если http2session.type равно http2.constants.NGHTTP2_SESSION_CLIENT.

import http2 from 'node:http2';
const clientSession = http2.connect('https://localhost:1234');
const {
  HTTP2_HEADER_PATH,
  HTTP2_HEADER_STATUS,
} = http2.constants;

const req = clientSession.request({ [HTTP2_HEADER_PATH]: '/' });
req.on('response', (headers) => {
  console.log(headers[HTTP2_HEADER_STATUS]);
  req.on('data', (chunk) => { // ..  });
  req.on('end', () => { // ..  });
});

Если задан параметр options.waitForTrailers, событие 'wantTrailers' возникает сразу после постановки в очередь последнего фрагмента отправляемых данных полезной нагрузки. После этого можно вызвать метод http2stream.sendTrailers(), чтобы отправить конечные заголовки узлу-получателю.

Если задан options.waitForTrailers, Http2Stream не будет автоматически закрыт после передачи последнего кадра DATA. Чтобы закрыть Http2Stream, пользовательский код должен вызвать либо http2stream.sendTrailers(), либо http2stream.close().

Если задан options.signal вместе с AbortSignal, а затем вызывается abort для соответствующего AbortController, запрос вызовет событие 'error' с ошибкой AbortError.

Псевдозаголовки :method и :path не указаны в headers; по умолчанию они соответственно равны:

• :method = 'GET'
• :path = /