An Agent dispatches requests against multiple different origins, creating and\nreusing a per-origin Pool (or Client) on demand. It is the default\ndispatcher used by request, stream, and fetch when no explicit\ndispatcher is supplied.
Requests are not guaranteed to be dispatched in their order of invocation.
\nimport { Agent, setGlobalDispatcher } from 'undici'\n\nconst agent = new Agent({ connections: 10 })\nsetGlobalDispatcher(agent)\n<Dispatcher>Agent keeps an internal map of origins to dispatchers. The first request to a\ngiven origin lazily creates a dispatcher through the configured factory, and\nsubsequent requests to the same origin reuse it. Idle dispatchers are closed\nautomatically once they have no open connections and are no longer busy.
Agent inherits all <PoolOptions> (and therefore all <ClientOptions>). The\nper-origin <Pool> it creates uses the default unlimited connections, so\nconcurrent requests to the same origin are spread across separate <Client>\ninstances on separate sockets.
\n" } ], "properties": [ { "textRaw": "Type: {boolean}", "name": "closed", "type": "boolean", "meta": { "added": [ "v3.2.0" ], "changes": [] }, "desc": "[!NOTE]\nBecause each concurrent request to an origin may use a different
\n<Client>,\nHTTP/2 multiplexing on a shared session does not apply unlessconnectionsis\nset to a small value (for exampleconnections: 1). See<PoolOptions>and\n<ClientOptions>for the full set of inherited options such asallowH2\n(defaulttrue) andmaxConcurrentStreams(default100).
true after agent.close() has been called.
true after agent.destroy() has been called, or after agent.close()\nhas been called and the shutdown has completed.
Aggregate statistics for the agent, keyed by origin. Each value is the\nClientStats or PoolStats object reported by the dispatcher currently\nserving that origin. Origins whose dispatcher does not expose stats are\nomitted.
import { Agent } from 'undici'\n\nconst agent = new Agent()\nawait agent.request({ origin: 'http://localhost:3000', path: '/', method: 'GET' })\nconsole.log(agent.stats)\n// { 'http://localhost:3000': PoolStats { ... } }\nRoutes the request to the dispatcher for options.origin, creating one through\nthe factory if needed. Throws an <InvalidArgumentError> when options.origin is not a non-empty string or <URL>, and a <MaxOriginsReachedError> when a new\norigin would exceed maxOrigins. Implements Dispatcher.dispatch().
Gracefully closes the agent and every dispatcher it owns, waiting for in-flight\nrequests to complete. Implements Dispatcher.close().
Forcefully destroys the agent and every dispatcher it owns, aborting all pending\nrequests. Implements Dispatcher.destroy().
See Dispatcher.connect(). The request is routed to the dispatcher for\noptions.origin.
See Dispatcher.pipeline(). The request is routed to the dispatcher for\noptions.origin.
See Dispatcher.request(). The request is routed to the dispatcher for\noptions.origin.
import { Agent } from 'undici'\n\nconst agent = new Agent()\nconst { statusCode, body } = await agent.request({\n origin: 'http://localhost:3000',\n path: '/',\n method: 'GET',\n})\n\nconsole.log('response received', statusCode)\nconsole.log('data', await body.text())\nSee Dispatcher.stream(). The request is routed to the dispatcher for\noptions.origin.
See Dispatcher.upgrade(). The request is routed to the dispatcher for\noptions.origin.
Emitted when a socket has been created for an origin and is ready to receive\nrequests. Forwarded from the underlying dispatcher's 'connect' event.
Emitted when a socket for an origin has disconnected. Forwarded from the\nunderlying dispatcher's 'disconnect' event.
Emitted when a connection attempt for an origin fails. Forwarded from the\nunderlying dispatcher's 'connectionError' event.
Emitted when an origin's dispatcher is no longer busy and can accept more\nrequests. Forwarded from the underlying dispatcher's 'drain' event.