{ "type": "module", "source": "doc/api/api-h2cclient.md", "modules": [ { "textRaw": "Class: H2CClient", "name": "class:_h2cclient", "type": "module", "desc": "

Extends: undici.Dispatcher

\n

A basic H2C client.

\n

Example

\n
const { createServer } = require('node:http2')\nconst { once } = require('node:events')\nconst { H2CClient } = require('undici')\n\nconst server = createServer((req, res) => {\n  res.writeHead(200)\n  res.end('Hello, world!')\n})\n\nserver.listen()\nonce(server, 'listening').then(async () => {\n  const client = new H2CClient(`http://localhost:${server.address().port}/`)\n\n  const response = await client.request({ path: '/', method: 'GET' })\n  console.log(response.statusCode) // 200\n  response.body.text.then((text) => {\n    console.log(text) // Hello, world!\n  })\n})\n
", "signatures": [ { "textRaw": "`new H2CClient(url[, options])`", "name": "H2CClient", "type": "ctor", "params": [ { "name": "url" }, { "name": "options", "optional": true } ], "desc": "

Arguments:

\n\n

Returns: H2CClient

", "modules": [ { "textRaw": "Parameter: `H2CClientOptions`", "name": "parameter:_`h2cclientoptions`", "type": "module", "desc": "", "modules": [ { "textRaw": "Parameter: `H2CConnectOptions`", "name": "parameter:_`h2cconnectoptions`", "type": "module", "desc": "", "displayName": "Parameter: `H2CConnectOptions`" } ], "displayName": "Parameter: `H2CClientOptions`" }, { "textRaw": "Example - Basic Client instantiation", "name": "example_-_basic_client_instantiation", "type": "module", "desc": "

This will instantiate the undici H2CClient, but it will not connect to the origin until something is queued. Consider using client.connect to prematurely connect to the origin, or just call client.request.

\n
\"use strict\";\nimport { H2CClient } from \"undici\";\n\nconst client = new H2CClient(\"http://localhost:3000\");\n
", "displayName": "Example - Basic Client instantiation" } ] } ], "modules": [ { "textRaw": "Instance Methods", "name": "instance_methods", "type": "module", "methods": [ { "textRaw": "`H2CClient.close([callback])`", "name": "close", "type": "method", "signatures": [ { "params": [ { "name": "callback", "optional": true } ] } ], "desc": "

Implements Dispatcher.close([callback]).

" }, { "textRaw": "`H2CClient.destroy([error, callback])`", "name": "destroy", "type": "method", "signatures": [ { "params": [ { "name": "error", "optional": true }, { "name": "callback", "optional": true } ] } ], "desc": "

Implements Dispatcher.destroy([error, callback]).

\n

Waits until socket is closed before invoking the callback (or returning a promise if no callback is provided).

" }, { "textRaw": "`H2CClient.connect(options[, callback])`", "name": "connect", "type": "method", "signatures": [ { "params": [ { "name": "options" }, { "name": "callback", "optional": true } ] } ], "desc": "

See Dispatcher.connect(options[, callback]).

" }, { "textRaw": "`H2CClient.dispatch(options, handlers)`", "name": "dispatch", "type": "method", "signatures": [ { "params": [ { "name": "options" }, { "name": "handlers" } ] } ], "desc": "

Implements Dispatcher.dispatch(options, handlers).

" }, { "textRaw": "`H2CClient.pipeline(options, handler)`", "name": "pipeline", "type": "method", "signatures": [ { "params": [ { "name": "options" }, { "name": "handler" } ] } ], "desc": "

See Dispatcher.pipeline(options, handler).

" }, { "textRaw": "`H2CClient.request(options[, callback])`", "name": "request", "type": "method", "signatures": [ { "params": [ { "name": "options" }, { "name": "callback", "optional": true } ] } ], "desc": "

See Dispatcher.request(options [, callback]).

" }, { "textRaw": "`H2CClient.stream(options, factory[, callback])`", "name": "stream", "type": "method", "signatures": [ { "params": [ { "name": "options" }, { "name": "factory" }, { "name": "callback", "optional": true } ] } ], "desc": "

See Dispatcher.stream(options, factory[, callback]).

" }, { "textRaw": "`H2CClient.upgrade(options[, callback])`", "name": "upgrade", "type": "method", "signatures": [ { "params": [ { "name": "options" }, { "name": "callback", "optional": true } ] } ], "desc": "

See Dispatcher.upgrade(options[, callback]).

" } ], "displayName": "Instance Methods" }, { "textRaw": "Instance Properties", "name": "instance_properties", "type": "module", "properties": [ { "textRaw": "`H2CClient.closed`", "name": "closed", "type": "property", "desc": "\n

true after H2CClient.close() has been called.

" }, { "textRaw": "`H2CClient.destroyed`", "name": "destroyed", "type": "property", "desc": "\n

true after client.destroyed() has been called or client.close() has been called and the client shutdown has completed.

" }, { "textRaw": "`H2CClient.pipelining`", "name": "pipelining", "type": "property", "desc": "\n

Property to get and set the pipelining factor.

" } ], "displayName": "Instance Properties" }, { "textRaw": "Instance Events", "name": "instance_events", "type": "module", "events": [ { "textRaw": "Event: `'connect'`", "name": "connect", "type": "event", "params": [], "desc": "

See Dispatcher Event: 'connect'.

\n

Parameters:

\n\n

Emitted when a socket has been created and connected. The client will connect once client.size > 0.

", "modules": [ { "textRaw": "Example - Client connect event", "name": "example_-_client_connect_event", "type": "module", "desc": "
import { createServer } from \"node:http2\";\nimport { H2CClient } from \"undici\";\nimport { once } from \"events\";\n\nconst server = createServer((request, response) => {\n  response.end(\"Hello, World!\");\n}).listen();\n\nawait once(server, \"listening\");\n\nconst client = new H2CClient(`http://localhost:${server.address().port}`);\n\nclient.on(\"connect\", (origin) => {\n  console.log(`Connected to ${origin}`); // should print before the request body statement\n});\n\ntry {\n  const { body } = await client.request({\n    path: \"/\",\n    method: \"GET\",\n  });\n  body.setEncoding(\"utf-8\");\n  body.on(\"data\", console.log);\n  client.close();\n  server.close();\n} catch (error) {\n  console.error(error);\n  client.close();\n  server.close();\n}\n
", "displayName": "Example - Client connect event" } ] }, { "textRaw": "Event: `'disconnect'`", "name": "disconnect", "type": "event", "params": [], "desc": "

See Dispatcher Event: 'disconnect'.

\n

Parameters:

\n\n

Emitted when socket has disconnected. The error argument of the event is the error which caused the socket to disconnect. The client will reconnect if or once client.size > 0.

", "modules": [ { "textRaw": "Example - Client disconnect event", "name": "example_-_client_disconnect_event", "type": "module", "desc": "
import { createServer } from \"node:http2\";\nimport { H2CClient } from \"undici\";\nimport { once } from \"events\";\n\nconst server = createServer((request, response) => {\n  response.destroy();\n}).listen();\n\nawait once(server, \"listening\");\n\nconst client = new H2CClient(`http://localhost:${server.address().port}`);\n\nclient.on(\"disconnect\", (origin) => {\n  console.log(`Disconnected from ${origin}`);\n});\n\ntry {\n  await client.request({\n    path: \"/\",\n    method: \"GET\",\n  });\n} catch (error) {\n  console.error(error.message);\n  client.close();\n  server.close();\n}\n
", "displayName": "Example - Client disconnect event" } ] }, { "textRaw": "Event: `'drain'`", "name": "drain", "type": "event", "params": [], "desc": "

Emitted when pipeline is no longer busy.

\n

See Dispatcher Event: 'drain'.

", "modules": [ { "textRaw": "Example - Client drain event", "name": "example_-_client_drain_event", "type": "module", "desc": "
import { createServer } from \"node:http2\";\nimport { H2CClient } from \"undici\";\nimport { once } from \"events\";\n\nconst server = createServer((request, response) => {\n  response.end(\"Hello, World!\");\n}).listen();\n\nawait once(server, \"listening\");\n\nconst client = new H2CClient(`http://localhost:${server.address().port}`);\n\nclient.on(\"drain\", () => {\n  console.log(\"drain event\");\n  client.close();\n  server.close();\n});\n\nconst requests = [\n  client.request({ path: \"/\", method: \"GET\" }),\n  client.request({ path: \"/\", method: \"GET\" }),\n  client.request({ path: \"/\", method: \"GET\" }),\n];\n\nawait Promise.all(requests);\n\nconsole.log(\"requests completed\");\n
", "displayName": "Example - Client drain event" } ] }, { "textRaw": "Event: `'error'`", "name": "error", "type": "event", "params": [], "desc": "

Invoked for user errors such as throwing in the onResponseError handler.

" } ], "displayName": "Instance Events" } ], "displayName": "Class: H2CClient" } ] }